Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zendesk Webhooks API

The Zendesk Webhooks API lets you create, manage, and monitor webhooks that send HTTP requests to specified URLs in response to events in Zendesk. It is the modern replacement for legacy targets, supporting event types for tickets, users, organizations, and messaging. You can create, list, update, test, and delete webhooks, and inspect invocation logs for troubleshooting.

Zendesk Webhooks API is one of 150 APIs that Zendesk publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Webhooks. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 0 operations across 8 channels, and defines 8 schemas. It is described by AsyncAPI 3.0.0, at version 1.0.0.

The API connects through a single server, {your-endpoint-host} (https).

0 operations 8 channels 8 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 3.0.0
API Version
1.0.0
Base URL
https://{subdomain}.zendesk.com

Messages & Schemas 8

The contract defines 8 schemas that model the data carried by its messages. The most detailed are TicketEventPayload (23 properties), UserEventPayload (13 properties), OrganizationEventPayload (12 properties), SatisfactionRatingPayload (9 properties). Each schema is shown below with its type and property counts.

TicketEvent
message
A webhook payload sent when a ticket-related event occurs in Zendesk. The payload contents are determined by the webhook's configured body template, which can…
UserEvent
message
A webhook payload sent when a user-related event occurs in Zendesk.
OrganizationEvent
message
A webhook payload sent when an organization-related event occurs in Zendesk.
SatisfactionRatingEvent
message
A webhook payload sent when a satisfaction rating is submitted by a customer.
TicketEventPayload
object
The payload for a ticket webhook event. Fields depend on the webhook body template configuration. This schema represents the default payload structure.
23 properties
UserEventPayload
object
The payload for a user webhook event.
13 properties
OrganizationEventPayload
object
The payload for an organization webhook event.
12 properties
SatisfactionRatingPayload
object
The payload for a satisfaction rating webhook event.
9 properties

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

zendesk-webhooks-asyncapi.yml Raw ↑

Other APIs Zendesk publishes across the network.

Zendesk Help Center Articles API
Zendesk Help Center Sections API
Zendesk Help Center Categories API
Zendesk Help Center Translations API
Zendesk Help Center Article Attachments API
Zendesk Help Center Article Comments API
Zendesk Help Center Article Labels API
Zendesk Help Center Topics API
Zendesk Help Center Posts API
Zendesk Help Center Post Comments API
Zendesk Help Center Votes API
Zendesk Help Center Content Subscriptions API