How to Create a Simple Webhook for Zendesk Rest API

To create a webhook for the Zendesk API, ensure that you have created your Zendesk definition first and set up a connection that is running.

If you’d rather watch a video demonstrating this, see below or click here.

1. Navigate to the Webhooks section under the Maintenance tab -> Rest Services -> Your Zendesk Rest Service and press the pencil
   
2. Then give it a name and press the pencil to edit
   
3. Then, on the settings tab, choose your webhook type and data source (if you want to add one). For my Example I will select ‘Callback’ contains data, and I’ll use the data source ‘Get Users.’
   
4. Next, you will go to the ‘callback setup’ and fill in the following fields.
   • Event Type Source: From Request body
   • Path: Type
   • For the three options, you can select them all, but for the values you will ‘create’ for which the syntax is: zen:event-type.user.create
     
     Then you can check if your data source looks correct in the data source field box, otherwise, press save.
5. Now move to the data sources tab and create a new ‘Realtime Trigger.’
   
   Find your ‘Zendesk Connections’ webhook and select it.
6. Fill out the data source information. You will need to give it a Description: Zendesk Realtime Test. Select the connection you set up to Zendesk. Then select the webhook we just created. You will need to select a user to run the integration, and you can select an option for the logs. I would recommend you select always ‘Save.’ Then press select fields, and select the fields you want to pull in. Press save, validate at the bottom, and save again.
   
   When you press save and all is successful it will create a callback url. We will use this in the next steps in Zendesk.
7. Next, go into your admin center in Zendesk, and find the Apps and Integrations sections. Scroll down to the webhooks option and select that.
   
   Once there press the ‘Create Webhook’ in the top right.
8. Then you can select ‘Zendesk Events,’ ‘Trigger,’ or ‘Automation.’ For this example, select ‘Zendesk Events’ and ‘Support User Created’ in the drop-down under User Events, and press ‘Next’ in the bottom right.
9. Next, fill in the rest of the information. First, the name can be whatever you like. I will put User Created Webhook. You don’t need a description. Then you can grab the Endpoint URL that we created back in SmartConnect. It will still be there even if you close the connection. Finally, you don’t need to adjust the authentication or add a header, so we can test the webhook
   
   Since we haven’t finished creating the integration this test won’t do much other than see if you get a successful send.
10. Once everything was successful on the Zendesk side of things, we can go back to SmartConnect to create a simple Realtime integration that will trigger these Zendesk events.
11. Navigate to the Processes and create a new integration by pressing the plus in the top right. Then fill in the integration ID and description.
    
    
12. Move to the Source tab and fill in the following fields.
    • Source Type: Realtime Event
    • Source: Your Zendesk Connection
    • Data source: Zendesk Realtime (TestForArticle)
    • Then you will need to add source grouping. This will depend on your data but an ID is generally recommended here.
      
      
13. You can send this information wherever. For this example, I will send it to file and map all of the fields.
    
    Then on the integration tab I match all the fields.
14. Finally, for Realtime integrations I like to set an email task that emails me when the integration is successful / erroring for testing purposes. You can copy these settings for testing purposes.
    
15. Once you have configured everything, you’ll want to press ‘Register’ at the bottom. It will bring you back to the real-time data source, but it will have a linked integration. Select the trigger on the create checkbox, and press ‘Validate” and ‘Save.’ As long as everything was successful you have created the Realtime integration with Zendesk!
    
    
16. Then when you go back into Zendesk and press the ‘Test Webhook button,’ You should get an email. If the test was a success or failure, you can also check your integration logs if you didn’t set up an email task.
    
    

If you have questions about how to create a simple webhook for Zendesk or other solutions? Feel free to send us an email at support@eonesolutions.com