Create Webhook Subscription

https://qa.api.wealthcare.com/notifications/1.1/subscriptions/webhooks

Create a subscription for sending events to a webhook. The subscription will be created in a "SetupInProgress" status. You can check on the progress of the webhook by calling the "Get Subscription" operation. Once the webhook is setup, the subscription will be updated to "Ready" status and will be able to send events.

Required Scopes: notifications_subscriptions_write

Request

Request body

name string

The name of the subscription.

Min Length: 5

Max Length: 50
administratorId string

The TPA Id or owner for receiving events.

Min Length: 3

Max Length: 10
events object
- source string
  
  The namespace for the event.
  
  Min Length: 5
  
  Max Length: 50
- type string
  
  The type of event that triggers the webhook.
  
  Min Length: 5
  
  Max Length: 50
active boolean

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
config object
- url string
  
  The URL to which the payload will be delivered.
  
  Max Length: 4000
- secret string
  
  SHA256 hash of an HMAC secret used to generate the HMAC hex digest value in the X-Signature header.
  
  Max Length: 1024

Response

Response body

subscriptionId string <uuid>

The unique identifier for the subscription.
name string

The name of the subscription.

Min Length: 5

Max Length: 50
administratorId string

The TPA Id or owner for receiving events.

Min Length: 3

Max Length: 10
events object
- source string
  
  The namespace for the event.
  
  Min Length: 5
  
  Max Length: 50
- type string
  
  The type of event that triggers the webhook.
  
  Min Length: 5
  
  Max Length: 50
active boolean

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
config object
- url string
  
  The URL to which the payload will be delivered.
  
  Max Length: 4000
- secretLastUpdateDate string <date-time>
  
  The date the secret was last updated.
status enum<string>

The status of the subscription.

Possible values: Ready SetupInProgress
updateDate string <date-time>

The date the subscription was last updated.
createdDate string <date-time>

The date the subscription was created.

Request URL

Authorization Bearer Token

Content Type

Request body (optional)

Load request example

No response yet.

No response yet.

Language

Example

{
  "subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Webhook Subscription",
  "administratorId": "T00123",
  "events": {
    "source": "com.alegeus.events.wca",
    "type": "CardTransaction"
  },
  "active": true,
  "config": {
    "url": "https://example.com/webhook",
    "secretLastUpdateDate": "2023-10-01T12:00:00Z"
  },
  "status": "Ready",
  "updateDate": "2023-10-01T12:00:00Z",
  "createdDate": "2023-10-01T12:00:00Z"
}

Min Length:	5
Max Length:	50

Min Length:	3
Max Length:	10

Min Length:	5
Max Length:	50

Min Length:	5
Max Length:	50

Notifications API | REST