v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Webhooks

Create new webhook subscription

Creates a new webhook subscription with the specified subscription details.

post/webhooks

Request body

keystring nullable

Unique key used for creating signature header in webhook notification requests.

namestring nullable

Name or description of the webhook subscription.

eventTypesstring[] nullable

The event types that the webhook subscription should be subscribed to.

eventNotificationUrlstring nullable

The uri to notify when an event has occurred.

Example request

{
  "key": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
  "name": "Listen to matter and contact changes",
  "eventTypes": [
    "matter.updated",
    "contact.created"
  ],
  "eventNotificationUrl": "http://yourdomain.com/notify"
}

Response

When request is successful. Returns the new webhook subscriptions.

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable

accountIdstring nullable

Unique identifier of the associated account.

namestring nullable

Name or description of the subscription.

eventTypesstring[] nullable

The event types that the webhook subscription is subscribed to.

eventNotificationUrlstring nullable

The uri to notify when an event has occurred.

createdDateUtcstring date-time

The webhook subscription creation date.

updatedDateUtcstring date-time

The webhook subscription last updated date.

lastUpdatedinteger

Last updated timestamp

Example response

{
  "accountId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
  "name": "Listen to matter and contact changes",
  "eventTypes": [
    "matter.updated",
    "contact.created"
  ],
  "eventNotificationUrl": "http://yourdomain.com/notify",
  "createdDateUtc": "2022-04-23T14:00:00Z",
  "updatedDateUtc": "2022-04-23T14:00:00Z",
  "lastUpdated": 637847425252027400
}