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#

id (ID!)#

id is the unique identifier for this specific endpoint.

enabled (Boolean!)#

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

url (String!)#

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

signingSecret (SigningSecret!)#

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

deliveries ([WebhookDelivery!]!)#

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

all (Boolean!)#

all is true when all events are subscribed to.

events ([WEBHOOK_EVENT_NAME!]!)#

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