Delete a Webhook
Permanently delete a webhook with the deleteWebhook mutation. Queued deliveries are skipped once the webhook is gone.
Use the deleteWebhook mutation to permanently remove a webhook. Once it’s deleted, Blue stops delivering events to its URL: any deliveries already queued for that webhook are skipped at send time (the delivery worker re-fetches the webhook before each POST and no-ops if it’s missing).
Deletion is permanent and cannot be undone. If you only want to pause deliveries while keeping the configuration, use disableWebhook instead — it flips the webhook to disabled without destroying it.
You can only delete a webhook that you created.
Request
mutation DeleteWebhook {
deleteWebhook(input: { webhookId: "webhook_123" }) {
success
}
}Authenticate with your personal access token headers:
blue-token-id: YOUR_TOKEN_ID
blue-token-secret: YOUR_TOKEN_SECRET
blue-org-id: YOUR_ORG_IDParameters
DeleteWebhookInput
| Parameter | Type | Required | Description |
|---|---|---|---|
webhookId | String! | Yes | The ID of the webhook to delete. |
Response
deleteWebhook returns a MutationResult.
{
"data": {
"deleteWebhook": {
"success": true
}
}
}Returns
| Field | Type | Description |
|---|---|---|
success | Boolean! | true when the webhook was deleted. |
operationId | String | Identifier for the operation when one is tracked asynchronously. Null for deleteWebhook. |
Errors
| Code | When |
|---|---|
WEBHOOK_NOT_FOUND | No webhook matches the provided webhookId. Message: Webhook was not found. |
FORBIDDEN | The webhook exists but was created by another user. Message: You are not authorized. |
{
"errors": [
{
"message": "Webhook was not found.",
"extensions": { "code": "WEBHOOK_NOT_FOUND" }
}
]
}Permissions
You must be authenticated, and you can only delete a webhook you created. Deleting a webhook owned by another user returns FORBIDDEN.
Webhooks are also tied to their creator’s lifecycle: deleting a user cascades to delete every webhook that user created.
Related
- List webhooks
- Disable a webhook — pause deliveries without deleting
- Update a webhook
- Webhooks overview