Skip to main content

WebhookEndpoint

No description

type WebhookEndpoint {
id: ID!
enabled: Boolean!
url: String!
signingSecret: SigningSecret!
deliveries: [WebhookDelivery!]!
all: Boolean!
events: [WEBHOOK_EVENT_NAME!]!
}

Fields

WebhookEndpoint.id ● ID! non-null scalar

id is the unique identifier for this specific endpoint.

WebhookEndpoint.enabled ● Boolean! non-null scalar

enabled when true will enable events to be sent to this endpoint.

WebhookEndpoint.url ● String! non-null scalar

url is the URL that we will POST event data to.

WebhookEndpoint.signingSecret ● SigningSecret! non-null object

signingSecret is the current secret used to sign the events sent out.

WebhookEndpoint.deliveries ● [WebhookDelivery!]! non-null object

deliveries store the deliveries for each event sent for the last 50 events.

WebhookEndpoint.all ● Boolean! non-null scalar

all is true when all events are subscribed to.

WebhookEndpoint.events ● [WEBHOOK_EVENT_NAME!]! non-null enum

events are the specific event names that this endpoint is configured to send for.

Returned By

webhookEndpoint query

Member Of

CreateWebhookEndpointPayload object ● DeleteWebhookEndpointPayload object ● DisableWebhookEndpointPayload object ● EnableWebhookEndpointPayload object ● RotateWebhookEndpointSigningSecretPayload object ● UpdateWebhookEndpointPayload object ● WebhookConfiguration object