Web developers typically use webhooks to invoke behavior in another system. For example, you can use webhooks to:
You must be an admin or an agent in acustom rolewith permission to create webhooks. Trial accounts are limited to a maximum of 10 webhooks and a rate limit of 60 invocations per minute.
About webhooks
There are two ways to connect a webhook to activity in Zendesk Support:
- Subscribe the webhook to one or more Zendesk events. Use this connection method to send requests based on organization, user, agent availability, help center, or community activity. For a list of supported event types, seeWebhook event typesin the API reference.
- Connect the webhook to atriggerorautomation. Use this connection method to send requests based on ticket activity.
A webhook that's subscribed to a Zendesk event can't connect to a trigger or automation. Similarly, a webhook that's connected to a trigger or automation can't subscribe to Zendesk events. You can't change an existing webhook's connection method.
Subscribing to Zendesk events
A webhook that's subscribed to one or more Zendesk events always sends requests using the POST HTTP method. The request includes a JSON payload that contains the event's data. You can't change the HTTP method or the payload for the request. For more information about event payload schemas, seeWebhook event typesin the API reference.
Connecting to triggers or automations
JSON
XML
Form-encoded content
You define the request's content when you connect the webhook to a trigger or automation. For webhooks that use the POST, PUT, or PATCH HTTP method with a JSON or XML request format, the content is the request payload. Webhooks using other HTTP methods or formats don't include a request payload. Instead, you can add custom URL parameters as an array of two key-value strings.
When defining the request's payload or URL parameters, you can use any of theavailable content placeholdersto insert ticket data into the request.
Webhook ordering and retries
When an event, trigger, or automation invokes a webhook, it queues the webhook job to be run but doesn't actually run the job immediately. Because webhook jobs are run independently, there is no guarantee that webhooks are executed in a particular order.
Webhook requests are automatically retried up to three times if the endpoint returns certain HTTP response codes. Unlike targets, consecutive failed requests won't deactivate webhooks. For more information and examples of retry scenarios, seeMonitoring webhooksin our developer documentation.
Creating a webhook
You can create a webhook in Admin Center.
To create a webhook
- InAdmin Center, click
Apps and integrationsin the sidebar, then selectWebhooks > Webhooks. - ClickCreate webhook.
- To subscribe the webhook to one or more Zendeskevents, selectZendesk eventsand select one or more event types from the dropdown.
- To connect the webhook to a trigger or automation, selectTrigger or Automation.
- ClickNext.
- Enter aNameandDescriptionfor the webhook.
- Enter theEndpoint URLthat is used to integrate with the third-party service or system. SeeWebhook endpoints.
When setting up a webhook to integrate with a third party, you may need to consult the third party's documentation.
- Select the webhook'sRequest methodandRequest format.
- Select theAuthenticationmethod for the webhook and provide any additional information required. SeeAuthenticating your webhook.
- (Optional) ClickAdd headerto add a custom header, and then enter aHeader nameandValue. To add up to four more headers, clickAdd another header. SeeCustom webhook headers.Note:Don't put sensitive information in your custom headers.
- (Optional) ClickTest webhookto ensure it's working as expected.
- ClickCreate webhookto create the webhook.
- For trigger and automation webhooks, you must connect the webhook to a trigger or automation. SeeConnect the webhook to a Support trigger or automation. After connecting the trigger or automation, return to theCreate webhookpage and clickFinish setup.
After you've created the webhook, you can view its details, subscriptions, and activity from the Webhooks page in Admin Center. SeeManaging webhooks.
Webhook endpoints
Webhooks send requests to the endpoint URL that you specify when creating them. The endpoint URL uses the following format:https://www.yourdomain.com/path.
Although it isn't required, the use of secure HTTP (HTTPS) is recommended. By providing a secure endpoint URL, you canenable authenticationand pass data safely.
Custom webhook headers
Custom headers provide a way to include additional information in the request your webhook sends and can make it easier to connect to some third-party services that have unique webhook header requirements. Note the following requirements and limitations for custom headers:
- To use custom headers, you must use a secure (HTTPS) endpoint URL.
- Don't include authentication credentials or other sensitive information in custom headers. Instead, use the supportedauthentication methods.
- Header names must be unique and can't have more than 128 characters. All alphanumeric US ASCII characters are supported, as well as the following symbols:
!,#,$,%,&,',*,+,-,.,^,_,`,|, and~. - Header values can be up to 1,000 characters in length and support all US ASCII characters from 0x20 to 0x7E.
Authenticating a webhook
If your webhook is integrating with a secure endpoint, you have three options for authenticating the webhook and the data it sends. You may want to reference third-party documentation about your endpoint's authentication requirements or work with a developer on your team to determine the correct authentication method for your webhook.
- None required: No authentication is configured or required.
- API key: Use an API key to authenticate the webhook.
- Basic authentication: Use a username and password to authenticate the webhook.
- Bearer token: Use an OAuth access token to authenticate the webhook.
If your developers want more information about webhook authentication, seeWebhook security and authentication.
For additional security, you can also verify the webhook's signature. For more informaiton, seeVerifying webhook authenticity.
Connect a webhook to a trigger or automation
To invoke a trigger and automation webhook, you must first connect it to a trigger or automation. The triggers and automations specify the circumstances under which the webhook should be invoked.
To connect a webhook to a Support trigger
- InAdmin Center, click
Objects and rulesin the sidebar, then selectBusiness rules > Triggers. - Create a new triggeror edit an existing one by hovering your mouse pointer over the options icon (
) and clickingEdit. - For triggers, underActions, clickAdd action. SelectNotify webhookand then select your webhook. Click保存.
- InAdmin Center, clickObjects and rulesin the sidebar, then selectBusiness rules > Automations.
- Create a new automationor edit an existing one by hovering your mouse pointer over the options icon () and clickingEdit.
- 下的自动化,Perform these actions, click the add action icon (
). SelectNotifications: Notify webhookand then select your webhook. ClickSubmit.
Testing a webhook
In Admin Center, you have the option to test the webhook with different event sources as well as requests. In addition to accessing existing webhooks specifically for testing, you can also test the webhook during creation or editing.
To test a webhook
- InAdmin Center, clickApps and integrationsin the sidebar, then selectWebhooks > Webhooks.
- Find the webhook in the list, click the options menu icon () on the webhook's row, and then clickTest webhook.
- In theTest webhookpanel, select an event to test. This is a sample request that you can use to test your endpoint URL.
- Enter the details of your test request—request body, parameters, or headers.
- ClickSend test. The response is visible in the panel below your test request.
68 Comments
What can I do with the Webhook Response Body that is returned? Can I access it from within a trigger? Or does that have to be done in code?
@Timothy Schauder
You are my hero! Thank you for providing the format for basic auth with token to Zendesk's own API. This was driving me crazy trying to figure this out!
Hi, hoping someone can help me here. I'm looking for the appropriate placeholders for {{assignee_id}} and {{satisfaction_rating}} for a json trigger that is notifying an active webhook (that is known to be working).
The end goal is to add a tag to the ticket made up of the agent's ID+rating, so if a ticket is rated several times, we can capture what rating goes to each agent, versus automatically assigning the satisfaction rating of the ticket to the last agent that touched it.
The json I'm using (that is not working -.-) is:
{
"ticket": {
"additional_tags": ["csat_{{assignee_id}}_{{satisfaction_rating}}"],
"id": "{{ticket.id}}"
}
}
The tag I'd want added is something like csat_1234355_bad
As you can see, it's not catching the placeholders, only adding the csat and underscores. And second issue would be that it's not adding it to tags. I don't know if it won't add it because it knows the tag created is not what was requested, so it doesn't send it over to the ticket, but I'd be surprised if it did do that.
Note: I was able to use a similar json and trigger with the same webhook to add assignee name to a text field when the ticket changes group (to track number of escalations per agents), but using the placeholder {{current_user.email}}. In all the documentation I find, I can't find that placeholder (I keep using variations of that placeholder because it works, but can't recall where it came from initially). I don't know what the assignee ID and ticket rating counterparts of that placeholder would be. Does anyone know? Any help would be appreciated!
I've seen these articles:
Edit:Just found that "additional_tags" is for the endpoint "tickets/update_many.json", and the webhook i'm currently using has endpoint "tickets/{{ticket.id}}". So that might be the issue, haven't created new webhook yet....but still don't know the right placeholders.
For the assignee id, you'd use /1263082116169 (seeZendesk Support placeholders reference for more info on placeholders). However, there isn't a placeholder that simply provides "good" or "bad" as text (there is one that would provide"Good, I am satisfied" (for example), but I think that would be more than you're looking for. As a workaround, you could create two copies of this trigger, one for Good (and Good with comment) ratings, and another for Bad/Bad with comment ratings, and hardcode "good" or "bad" into the string yourself.
Although I hear your trigger/webhook combo is working, I do have to provide the caveat that updating triggers this way can be unreliable: see Can I use a trigger and a webhook to update tickets?
@...谢谢你！这篇文章提供了占位符I needed (I used ticket.assignee.id for my purposes). I continue unable to update the tickets with the update-many endpoint. However, it all works with the tickets/{ticket.id} endpoint. The problem is it replaces all ticket tags with the one we're adding, which is what I did not want to do. So I'll continue messing around with this, but REALLY appreciate the correct placeholder article!
Webhooks targets - What max no of webhooks are allowed in LIVE?
Is there a way to handle status codes, like 4xx or 5xx responses ?
There's no documented limit for the number of web-hooks you can created. However, it is advisable to always check the API rate limit of the web-hooks that will be utilized. For Zendesk API rate limits, please refer toUsage Limits.
@Julien,
The only natively available option is to see the status of each call. You can go to each web-hook and click the activity tab.
Hi All,
i am trying to create a webhook with end point url ashttps://yoursubdomain.zendesk.com/api/v2/tickets/{{ticket.id}}.json(i replaced your domain with our subdomain) however it returns with an error
If someone can help please!
Hi Prakash,
What is the error you're seeing?
Could be a number of things, are you authenticating the call?
https://support.zendesk.com/hc/en-us/articles/4408839108378?page=2#topic_qbn_v4w_dpb
If I use a webhook with a ticket id placeholder inside the url, the activity log dont show any information about the used url. So I don't know anything about the request if the body was empty. Could you please add the request url to the activity log information?
HeyMaik Künnemann,
You'll want to share this feedback in ourFeedback on the ticketing system (Support)topic since that is actively being monitored by our Product Managers. That doesn't guarantee that you'll receive a response but we do monitor and follow up with users as we have information to share.
Let me know if you have another questions for me in the meantime.
Cheers!
我正在调查创建新线程ets to our other internal system. However this requires data to be in form-data format. Is this something that I can do in ¨Webhooks?
Also, can I pick up values from the response of internal system such as the ticket number of the internal system which is returned when submitting this call?
I need to post this type of request to the internal system and pick up the response below to ticket fields.
Otto LindqvistI'm hoping we see an answer to your questions! I think according to this article you should be able to do both. But I have no idea how and I've previously run into similar challenges when doing external chat bot integrations.
For the form-data, I think this part of the article makes it sound like you can send form-data in a webhook:
As for receiving the returned values and updating a ticket's custom fields. This sentence from the article makes it sound like that should be possible:
I'm sure I don't fully understand everything because I would not know how to send form data in a webhook and don't know how to make Zendesk do anything with the response from an external system. Maybe I don't understand what you want to do or maybe I'm misinterpreting the article.
The only way I would currently be able to accomplish something like this would be to send the ticket ID to the other system and then have the other system make a separate call to Zendesk using that Ticket ID to put the two values into the custom fields of that associated Ticket ID.
Thanks for the replyRonald!
What you quoted from the docs is excactly what I read and understood also. However I could not find documentation about that how to use those features, especially the latter.
But after commenting and continuying reading the docs I came to conclusion that webhooks wont work in my case anyways because of the custom header issue already discussed in this article earlier. So I'll need to find some integrator for this, I already tried Zapier but didnt get the results I was looking for.
Any documentation of how the response body received from the GET method webhook can be accessed and used? Can it be used to update values of the specific tickets?
Unfortunately, there's none (at least in Zendesk). This workflow will require you to leverage your own/third-party app that will parse the data from using GET then update the ticket using the Update Ticket API.
Hi Zendesk community,
I've created a trigger that is supposed to sent a User Date Custom Field value to a Ticket Date Custom Field Value.
But it doesn't work because the User Date Custom Field placeholder sends a date on this format: 2022-10-13 00:00:00 +0000 and the Ticket Field only accepts this format: 2022-10-13.
I tried liquid : {{ticket.requester.custom_fields.date_dernier_appel | date: "%Y-%m-%d"}} but JSON doesn't accept it..
I tried $substring (example:$substring("Hello World", 3) => "lo World") but it didn't work too..
Do you have a solution please?
Best regards,
Raphaël
HiRaphaël Péguet - Officers.fr
While the URL does allow for substitutions, the JSON seems to be uninterpreted text only.
At least, I haven't had any success trying to substitute anything in the payload.
HiPeter Hochstrasser,
Thanks for your answer, as placeholders are interpreted i hoped that liquid will be but it's not.. I still hope finding a solution with Zendesk only, I will put it here if I do!
Best regards,
We've been back and forth with Zendesk support for the past month and have not got anywhere so I'm hoping if anyone reads this and can help out will comment. Our tickets used to automatically CC the CSMs of the Salesforce account. For some reason this stopped working and we were told to create webhooks. We have and it still fails the test but when I check Activity it says success. Does anyone know what we can do to have the Salesforce CSMs email CC on every ticket?
This is our current webhook and trigger set up. Any help is greatly appreciated.
HiKelly Centeno-- I'm pretty sure your setup is correct and is already actually working.
A couple of things about your test setup from the screenshots of the Webhook creation page:
In order to test a webhook like this I would submit a test ticket and then use that specific ticket ID rather than the {{ticket.id}} placeholder in the endpoint.
And I would take the request body you have in the second screenshot, from the trigger, and paste that into the test box but again you'll have to replace the custom field placeholder values for the actual values that are stored in the associated custom fields.
据我所知,你们公司的唯一问题uld have with the setup is if the custom field values with the intended collaborators don't conform to the requirements of the additional_collaborators property. I'm pretty sure you can simply pass just an email address there but it can also take IDs and objects consisting of a name and email property. I'm assuming you're storing an email address in those custom organization and ticket fields so that should be all good!
Hello. As 2FA Session management has not been securely implemented (to mandate users must use 2FA with every login event) I would like to establish an automation to achieve:
At 7pm each night - destroy all active sessions.
Can you please provide guidance to this.
- I have established a webhook that calls the Sessions API and is authenticated via token.
- How to build the automation that is preferably time dependant. I imagine the logic will need to be something like: Loop through all open sessions - destroy each active session.
I am not a developer, and at this time I can't see how to achieve this in automation. Please do provide some detailed guidance - especially given the 2FA implementation is not secure.
Thanks,
Has anyone tried creating a webhook for discord since Zendesk discord integration is no longer supported.
Hello all!
I've managed to create the webhooks and triggers to update tickets. I am stuck though on trying to populate a ticket custom field from a ticket.organization_custom _field.
Is there anyone here who has done it?
example
Organization_custom_field (id:34) is automatically populated through internal code.
I want this info to be transferred to a ticket_custom_field (id:45).
I need the JSON body to do this.
Thanks in advance
Hi Efthymis!
When you want to update custom fields on tickets via API, you need to have to have correct structure. Custom fields on the ticket JSON needs to be on an array like this:
Thank you Otto for the help,
Still my main question is "what's the placeholder for an organization custom field"? Can you help?
Thanks
Efthymis Kouzelis
There is one for the tag and another for the value of such a field, you can reference this:
https://support.zendesk.com/hc/en-us/articles/4408886858138-Zendesk-Support-placeholders-reference
hello why my webhooks got 400 bad request and no username
got this error
"code": 400,
"name": "Bad Request",
I'd recommend reaching out to our Customer Support team regarding this issue so they can take a look at your account. More information on contacting their team here:Contact Zendesk Customer Support
Hope this helps!
Pleasesign into leave a comment.