Skip to main content
Version: 3.x

Webhook

Webhook.

type Webhook implements Node {
id: ID!
name: String!
events: [WebhookEvent!]!
syncEvents: [WebhookEventSync!]!
asyncEvents: [WebhookEventAsync!]!
app: App!
eventDeliveries(
sortBy: EventDeliverySortingInput
filter: EventDeliveryFilterInput
before: String
after: String
first: Int
last: Int
): EventDeliveryCountableConnection
targetUrl: String!
isActive: Boolean!
secretKey: String
subscriptionQuery: String
}

Fields

id (ID!)

name (String!)

events ([WebhookEvent!]!)

List of webhook events.

syncEvents ([WebhookEventSync!]!)

List of synchronous webhook events.

asyncEvents ([WebhookEventAsync!]!)

List of asynchronous webhook events.

app (App!)

eventDeliveries (EventDeliveryCountableConnection)

Event deliveries.

Event delivery sorter.

Event delivery filter options.

Return the elements in the list that come before the specified cursor.

Return the elements in the list that come after the specified cursor.

Return the first n elements from the list.

Return the last n elements from the list.

targetUrl (String!)

Target URL for webhook.

isActive (Boolean!)

Informs if webhook is activated.

secretKey (String)

Used to create a hash signature for each payload.

subscriptionQuery (String)

Used to define payloads for specific events.

Interfaces

Node

An object with an ID