Skip to main content

createWebhookEndpoint Mutation

Creates a new 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 (CreateWebhookEndpointInput!)

ArgumentTypeDescription
nameString!Friendly name for the webhook endpoint.
urlString!The URL where webhook events will be sent.
descriptionStringAdditional notes about this webhook endpoint configuration.
secretStringSecret key used for HMAC signature generation. If provided, all webhook payloads will include an X-Webhook-Signature header.
headersStringA JSON object of key/value pairs that will be sent as headers with each webhook request.
enabledBooleanWhether this webhook endpoint is currently enabled. Disabled endpoints will not receive events.
eventTypes[String]!List of event types to subscribe to.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (CreateWebhookEndpointPayload)

clientMutationId (String)
errors ([ErrorType!]!)
webhookEndpoint (WebhookEndpoint)