Get a webhook subscription

Returns the details of the webhook subscription with the specified ID.

The response does not include the webhook signing secret. If you lost the secret, you can regenerate it.

webhook_subscription_idstringRequired

ID of the webhook subscription. This is the same value as the webhook_subscription_id you receive in webhooks.

Successful Response

idstringformat: "uuid"

A unique URL assigned to this webhook subscription. This ID is also included in the webhook data as the webhook_subscription_id field.

event_typeslist of strings

Events included in this webhook subscription. An empty array means the subscription includes all events triggered by the specified object_type.

object_typeenum

The object type associated with this webhook subscription.

statusenum

Allowed values:

urlstringformat: "uri">=1 character<=2083 characters

URL to which the webhooks are sent. The same URL can be used by multiple webhook subscriptions.

1	{
2	"id": "id",
3	"event_types": [
4	"created",
5	"onboarding_requirements.updated",
6	"onboarding_requirements.status_updated"
7	],
8	"object_type": "account",
9	"status": "enabled",
10	"url": "https://example.com/your-webhook-listener"
11	}