Webhooks
Test Webhook
Changed onTests a new or existing webhook.
When testing an existing webhook, the existing webhook data will be attached automatically as part of the outbound test request. The data includes the request format, http method, authentication method (only if same type and add_position are attached), and signing secret. The request payload data will overwrite existing webhook data in the outbound test request.
post/api/v2/webhooks/test
Request
- Base URLhttps://example.zendesk.com
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
webhook_idstring
The webhook to be tested. Only required for testing an existing webhook.
Request body
Response
Test completed successfully
Changes
- info
the request property
//////became optional - info
the request property
//////became optional - info
the request property
//////became optional
- info
- breaking
removed from the
/request propertyanyOflist - info
added to the
/request propertyoneOflist
- breaking