Webhook Object
Root Connection
All Webhook objects of an account are accessible by a query on the root connection webhooks
.
Such a query will return a WebhookConnection!
, which contains the Webhook objects in its
nodes
field.
WebhookConnection!
)
Root connection for retrieving Webhook records.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
filter |
WebhookFilter
|
Filter to determine which Webhook records are returned. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
Fields
The fields in this section list which values can be retrieved when querying Webhook records.
Account
)
The account this record belongs to.
ISO8601Timestamp
)
The date and time at which the record was created.
String
)
Description of the webhook's purpose.
Boolean
)
Whether the webhook will be triggered when the event occurs.
WebhookEvent
)
Event that will trigger this webhook.
ID!
)
Unique identifier of the record.
String
)
Comma separated list of email addresses who will be informed when the webhook execution fails.
String
)
Name of this webhook.
String
)
An identifier for the client application submitting the resource or the name of an external system.
String
)
The unique identifier of the resource in an external system.
ISO8601Timestamp
)
The date and time of the last update of the record. If the record has no updates it contains the createdAt
value.
String
)
Publicly accessible URI that 4me can use to POST http messages to.
WebhookPolicy
)
The webhook policy to use for cryptographic signing of the messages.
Connections
The connection fields in this section allow (paged) access to objects related to a specific Webhook record.
The actual objects will be in the nodes
field of the connection.
AttachmentConnection
)
Inline images linked to the Description field.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
Implements
Webhook implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a Webhook.