Skip to content

Webhook Management

Notice

The content of the domainComponentNames is always a list of strings, each of which should be in lower case and contain only letters. These names might be on its plural version in some cases, so be mindful of the spelling of it. In case of mistakes, however, the API will yield a 400 Bad Respose.

Creating a Subscription

Authorised clients will be allowed to register webhooks, so it can listen to webhook events in our system. Clients can register one webhook listener for each business domain entity type.

  • URL: /management/webhooks/create-subscription
  • Method: POST
  • Content-Type: application/json
  • Payload: as described below
{
  "domainComponentNames": [ "contacts", "agents" ],
  "businessIds": ["00000000-0000-0000-0000-000000000001"],
  "targetUrl": "https://my.service/my-pre-signed-url"
}

Where:

  • domainComponentNames: is the list of Business Domain Entities which the client is interested in
  • businessIds: optionally narrows down the scope, listening to only a few business IDs
  • webhookUrl: the public-URL which will receive a Post with an Envelope Payload informing the operation result.

Updating a Subscription

  • URL: /management/webhooks/update-subscription/:id
  • Method: POST
  • Content-Type: application/json
  • Payload: as described below
{
  "domainComponentNames": [ "contacts", "agents" ],
  "businessIds": ["00000000-0000-0000-0000-000000000001"],
  "targetUrl": "https://my.service/my-pre-signed-url"
}

Deleting a Subscription

  • URL: /management/webhooks/delete-subscription/:id
  • Method: POST
  • Content-Type: application/json

Listing Subscriptions

  • URL: /management/webhooks/list-subscriptions
  • Method: POST