Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Webhook Subscriptions

Add Webhook Subscription

Endpoint to add a new WebhookSubscription.

post/business/v2/webhooks/subscriptions

Headers

X-Soldo-Fingerprintstring required

Advanced authentication: SHA512SUM of the fingerprint values listed in the fingerprint order for this endpoint.

Example:{{fingerprint}}
X-Soldo-Fingerprint-Signaturestring required

Advanced authentication: Signature of the X-Soldo-Fingerprint.

Example:{{fingerprint_signature}}

Request body

webhook_urlstring required

The url of the WebhookSubscription.

enabled_eventsWebhookEventName[] required

The list of the WebhookSubscription enabled events.

descriptionstring

The description of the WebhookSubscription.

activeboolean required

The status of the WebhookSubscription (if false, notifications are not sent).

Example request

{
  "webhook_url": "https://your_domain.com/xx/xx",
  "enabled_events": [
    "card_activated"
  ],
  "description": "Google Ads Campaign"
}

Response

The returned resource is a single WebhookSubscription.

idstring uuid

The WebhookSubscription ID.

webhook_urlstring

The URL of WebhookSubscription.

enabled_eventsWebhookEventName[]

The list of subscribed events.

descriptionstring

A custom description of the WebhookSubscription.

activeboolean

The status of the WebhookSubscription.

creation_datestring

The date and time when the WebhookSubscription was created (sortable: yes).

last_updatestring

The last date and time when the WebhookSubscription was last updated (sortable: yes).

Example response

{
  "webhook_url": "https://your_domain.com/xx/xx",
  "description": "Report updates",
  "active": true,
  "creation_date": "2017-06-01T12:48:40Z",
  "last_update": "2017-06-01T12:48:40Z"
}