SOsoldo
Webhook Subscriptions

Get Webhook Subscription

Changed on

Endpoint to retrieve a specific WebhookSubscription by ID.

get/business/v2/webhooks/subscriptions/{webhookSubscriptionsId}

Request

Path parameters

webhookSubscriptionsIdstring required

The WebhookSubscription ID.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

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"
}

Changes

  • 9fa34523c5a0Revision changes
    • warning

      added the new user_deleted enum value to the / response property for the response status

  • e55752f89428Revision changes
    • warning

      added the new inter_account_transfer enum value to the / response property for the response status

    • warning

      added the new inter_account_transfer_recurring_billing enum value to the / response property for the response status