Delete a webhook

The "Delete a Webhook" API allows users to permanently remove an existing webhook configuration from a specific event in Zoho Backstage. By passing the unique webhook_id, along with the corresponding portal_id and event_id, you can delete the webhook and stop all future webhook notifications associated with it.

Once deleted, the webhook will no longer trigger HTTP notifications for any subscribed actions. This operation is irreversible, and if required again, a new webhook must be created.

This endpoint is useful when you want to:

  • Disable an integration permanently

  • Remove outdated or unused webhook configurations

  • Stop sending event activity notifications to an external endpoint

  • Clean up test or temporary webhook setups

To delete a webhook successfully, you must provide the portal_id, event_id, and webhook_id.

 

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

 

OAuth Scope

zohobackstage.webhook.DELETE

 

Path Parameters

  • portal_id (Long Integer)
    The unique identifier of the portal where the webhook exists. This ensures the deletion request is scoped to the correct Zoho Backstage portal. For example, "portal_id": "19593237" specifies the portal with ID 19593237.

  • event_id (Long Integer)
    The unique identifier of the event associated with the webhook. Since event-level webhooks are scoped to a specific event, this ensures the correct event context. For example, "event_id": "2000000116588" specifies the event with ID 2000000116588.

  • webhook_id (Long Integer)
    The unique identifier of the webhook you want to delete. This ID identifies the exact webhook configuration within the event. For example, "webhook_id": "3000000013051" specifies the webhook with ID 3000000013051.

Response Structure and Field Explanations

  • status_code (Integer)
    Represents the HTTP status code indicating the result of the delete operation. A value of 200 indicates that the webhook was successfully deleted. For example, "status_code": "200" confirms that the deletion request was processed successfully.

  • message (String)
    A descriptive message indicating the result of the operation. This message confirms whether the webhook deletion was successful. For example, "message": "Webhook deleted" confirms that the webhook has been successfully removed from the event.

URL

Copied/v3/portals/{portal_id}/events/{event_id}/webhooks/{webhook_id}

Example

Copiedhttps://zohoapis.com/backstage/v3/portals/19593237/events/2000000116588/webhooks/3000000013051

Sample Response

Copied{
  "status_code": "200",
  "message": "Webhook deleted"
}