type Webhook
A subscription that delivers event notifications to an owner-supplied HTTPS endpoint. Referenced by id so its url or event list can change without affecting referencing records.
| Field | Type | Description |
|---|---|---|
id | ID! | |
ownerId | ID! | The entity this webhook belongs to. Where a webhook can only belong to one kind of entity, this is that entity's own id; where it can belong to several, the form also names the kind. |
url | String! | Destination HTTPS endpoint that receives event payloads via POST. |
events | [String!]! | Event types this webhook is subscribed to (e.g. "commitment.created"). |
description | String | Optional human-readable label describing the webhook's purpose. |
enabled | Boolean! | Whether the webhook is active and delivering events. |
secretCheckValue | String! | Checksum of the signing secret, used to confirm which secret is configured without exposing it. The raw secret is only ever returned by webhookCreate and webhookRotateSecret. |
createdAt | DateTime! | |
updatedAt | DateTime! |