| Field | Type | Required | Description | Example |
|---|---|---|---|---|
resource |
String | ✔️ | Indicates the response contains a webhook subscription object. Will always contain the string webhook for this endpoint. |
webhook |
id |
String | ✔️ | The identifier uniquely referring to this subscription. | hook_tNP6fpF9fLJpFWziRcgiH |
url |
String | ✔️ | The subscription's events destination. | https://example.com/webhook-endpoint |
profileId |
Optional<String> | ✔️ | The identifier uniquely referring to the profile that created the subscription. | pfl_YyoaNFjtHc |
createdAt |
String | ✔️ | The subscription's date time of creation. | 2023-03-15T10:00:00+00:00 |
name |
String | ✔️ | The subscription's name. | Profile Updates Webhook |
eventTypes |
List<WebhookEventTypes> | ✔️ | The events types that are subscribed. | [ "profile.create", "profile.blocked" ] |
status |
WebhookStatus | ✔️ | The subscription's current status. | enabled |
mode |
Mode | ✔️ | Whether this entity was created in live mode or in test mode. | live |
links |
EntityWebhookLinks | ✔️ | An object with several relevant URLs. Every URL object will contain an href and a type field. |