Skip to main content
POST
/
v1
/
webhook
/
create
Webhook Create
curl --request POST \
  --url https://api.decodahealth.com/v1/webhook/create \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '{
  "notificationEmail": "<string>",
  "subscriptions": [
    "PATIENT_CREATED"
  ],
  "url": "<string>"
}'
{
  "createdDate": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "notificationEmail": "<string>",
  "secret": "<string>",
  "subscriptions": [
    "PATIENT_CREATED"
  ],
  "updatedDate": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Body

application/json
​
subscriptions
enum<string>[]
required

List of event types the webhook subscribes to.

​
url
string
required

The URL where the webhook will send notifications.

​
notificationEmail
string | null

Email address for sending notifications about delivery failures.

Response

Successful Response

​
createdDate
string<date-time>
required

The date and time when the webhook was created.

​
id
string
required

Unique identifier for the webhook.

​
secret
string
required

The secret key used for signing the webhook payloads.

​
subscriptions
enum<string>[]
required

List of event types the webhook is subscribed to.

​
url
string
required

The URL where the webhook sends notifications.

​
notificationEmail
string | null

Email address for sending notifications about delivery failures.

​
updatedDate
string<date-time> | null

The date and time when the webhook was last updated.