A webhook endpoint.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
createdAt |
\DateTime | ✔️ | Creation timestamp of the object. | |
modifiedAt |
\DateTime | ✔️ | Last modification timestamp of the object. | |
id |
string | ✔️ | The ID of the object. | |
url |
string | ✔️ | The URL where the webhook events will be sent. | https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0 |
name |
?string | ➖ | An optional name for the webhook endpoint to help organize and identify it. | |
format |
Components\WebhookFormat | ✔️ | N/A | |
secret |
string | ✔️ | The secret used to sign the webhook events. | polar_whs_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK |
organizationId |
string | ✔️ | The organization ID associated with the webhook endpoint. | |
events |
array<Components\WebhookEventType> | ✔️ | The events that will trigger the webhook. | |
enabled |
bool | ✔️ | Whether the webhook endpoint is enabled and will receive events. |