Models
Webhook
Properties
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the webhook. Use it with the get, update and delete webhook endpoints. Example: "wh_01JQZ8X0M4T7RB6K9V2NDHW3PA" |
teamId | string | Yes | The ID of the team whose events this webhook receives. Example: "team_01JQZ8X0M4T7RB6K9V2NDHW3PA" |
companyId | string | null | Yes | The company this webhook is limited to. Null means it receives the events of every company in the team. Example: null |
url | string (uri) | Yes | The HTTPS endpoint events are delivered to, as a JSON POST body. Example: "https://example.com/hooks/recommand". Format: uri |
secret | string | null | Yes | The signing secret, returned in full on every read. Null when signing is off. When it is set, each delivery carries an X-Signature: sha256=<hex> header, an HMAC-SHA256 of the raw request body; recompute it to confirm the request came from us |
createdAt | string (date-time) | Yes | When the webhook was created. Format: date-time |
updatedAt | string | null | Yes | When the webhook was last changed. Null when it has not changed since it was created. Format: date-time |