Delete webhook

deleteWebhook(input: DeleteWebhookInput!): DeleteWebhookPayload!

Requires project.agents.write; API keys also need delete scope.

Arguments

ArgumentTypeRequired
inputDeleteWebhookInput!Yes

Input fields

input

DeleteWebhookInput

FieldTypeRequiredDescription
projectReferenceStringNo
idID!YesWebhook definition id. Future deliveries for it are disabled. A missing webhook fails with RESOURCE_NOT_FOUND.

Response

Returns DeleteWebhookPayload!. Open the type for its fields and nested types.

FieldTypeDescription
okBoolean!Always true: the webhook is deleted and future deliveries for it are disabled.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation DeleteWebhook($input: DeleteWebhookInput!) {
  deleteWebhook(input: $input) {
    ok
  }
}
json
{
  "input": {
    "id": "00000000-0000-4000-8000-000000000001",
    "projectReference": "example-project"
  }
}