Skip to main content

webhookEndpoint Query

Returns the specified WebhookEndpoint object.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_admin_users].

Input fields​

ArgumentTypeDescription
idID!The ID of the WebhookEndpoint object.

Return fields (WebhookEndpoint)​

allowRemove (Boolean!)​

Specifies whether the signed-in User can remove the WebhookEndpoint.

allowUpdate (Boolean!)​

Specifies whether the signed-in User can update the WebhookEndpoint.

createdAt (DateTime!)​

The timestamp at which the object was created.

description (String)​

Additional notes about this webhook endpoint configuration.

enabled (Boolean!)​

Whether this webhook endpoint is currently enabled. Disabled endpoints will not receive events.

eventTypes ([String!]!)​

List of event types this webhook endpoint subscribes to. Must include at least one event type.

headers (JSONString)​

A JSON object of key/value pairs that will be sent as headers with each webhook request.

id (ID!)​

The ID of the object

name (String!)​

Friendly name for the webhook endpoint.

secret (String)​

Secret key used for HMAC signature generation. If provided, all webhook payloads will include an X-Webhook-Signature header.

updatedAt (DateTime!)​

The timestamp at which the object was most recently updated.

url (String!)​

The URL where webhook events will be sent.