What's my plan?

Available on all Suite plansAvailable on all Support plans

Note: URL and branded targets will be deprecated on December 13, 2024. For more information, see the announcement.

Previously, targets have been used to pass information to external, cloud-based applications and services to notify them of changes in Zendesk. This article describes how to convert most existing targets you have into webhooks.

This article includes the following topics:
  • Create a new webhook based on your target
  • Configure a trigger to send the webhook notifications
  • Deactivate your target and associated triggers

About converting targets to webhooks

When converting targets into webhooks, the order of your actions matter for process continuity. We recommend the following process:
  1. Create a new webhook based on your target.
  2. Configure a trigger to send the webhook notification.
  3. Verify the new webhook and trigger are working as expected, and then deactivate your target and any triggers associated with the target.

Converting Clickatell, Pivotal, Twilio, X Corp, and Yammer targets

There's no direct way to map Clickatell, Pivotal, Twilio, X Corp (formerly Twitter), and Yammer target configurations to webhooks. We recommend looking into Zendesk Marketplace apps that can meet your needs.

Create a new webhook based on your target

To convert your targets into webhooks, you'll want to have the target's details open in one window and the webhook open in another.

To create a webhook based on a URL target

  1. In a browser window, open the URL target.
    1. In Admin Center, click Apps and integrations in the sidebar, then select Targets > Targets.
    2. Find the target you want to convert to a webhook and click Edit.
  2. In a separate browser window, open the Webhooks page.
    • In Admin Center, click Apps and integrations in the sidebar, then select Actions and webhooks > Webhooks.
  3. Click Create webhook.
  4. Select Trigger or automation as the way to connect and click Next.
  5. Map the target values to the webhook fields. For detailed mapping instructions, see:
    • Basecamp
    • Campfire
    • Get Satisfaction
    • Jira
    • URL
  6. Click Create webhook.

Mapping Basecamp target configurations to webhooks

Map the Basecamp target values to the webhook fields as follows:
  • Title: The webhook's Name.
  • URL: The webhook's Endpoint URL.
  • For the webhook's authentication, choose one of the following methods:
    • Username and Password: Set the webhook's Authentication to Basic authentication and enter the Basecamp username and password. You can't copy and paste the password.
    • API token: Set the webhook's Authentication to API key and enter the Campfire target's API token.
  • Project ID: Append to the end of the webhook's Endpoint URL with /projects/[ID]. Example: https://corp.basecamphq.com/projects/2612430.
  • Resources: Append to the end of the webhook's Endpoint URL, following the project ID.
    • Message: Append with /posts/[ID]/comments. Example: https://corp.basecamphq.com/projects/2612430/posts/25611692/comments
    • To-do: Append with /todo_lists/[ID]. Example: https://corp.basecamphq.com/projects/2612430/todo_lists/25611692.

Mapping Campfire target configurations to webhooks

Map the Campfire target values to the webhook fields as follows:
  • Title: The webhook's Name.
  • Subdomain: The webhook's Endpoint URL.
  • API Token: Set the webhook's Authentication to API key and enter the Campfire target's API token.
  • Room: Append this information to the webhook's Endpoint URL.
  • SSL: This isn't applicable when creating a webhook.
  • Preserve format: This isn't applicable when creating the webhook.

Mapping Get Satisfaction target configurations to webhooks

Map the Get Satisfaction target values to the webhook fields as follows:
  • Title: The webhook's Name.
  • Company Name: Incorporate into the webhook's Endpoint URL. For example: https://getsatisfaction.com/yourcompany/
  • Email and Password: Set the webhook's Authentication to Basic authentication and enter the Get Satisfaction username and password. You can't copy and paste the password.

Mapping Jira target configurations to webhooks

Zendesk highly recomends using the Jira app in the Zendesk Marketplace to replace Jira targets. However, if you choose not to use the Jira app, you can map the Jira target values to the webhook fields as follows:
  • Title: The webhook's Name.
  • URL: The webhook's Endpoint URL.
  • Username and Password: Set the webhook's Authentication to Basic authentication and enter the JIRA username and password. You can't copy and paste the password.

Mapping URL target configurations to webhooks

Map the URL target values to the webhook fields as follows:
  • Title: The webhook's Name.
  • URL: The webhook's Endpoint URL.
  • Method: The webhook's Request method.
  • Attribute name: This isn't required when creating the webhook, but will be used when configuring the trigger actions.
  • Basic authentication: Set the webhook's Authentication to Basic authentication and enter the URL target's username and password. You can't copy and paste the password.
  • Additionally, in the webhook you need to set the Request format to Form encoded.

Configure a trigger to send the webhook notifications

You should already have a trigger configured to send notifications based on the target. You can edit this trigger or clone it, or you can create a new trigger.

To edit an existing trigger to send the webhook notification
  1. In Admin Center, click Objects and rules in the sidebar, then select Business rules > Triggers.
  2. Edit or clone an existing trigger.

    Note the Message value for the Notify by > Target action. You'll re-use this with your new webhook-based action.

  3. Under Actions, click Add action and select Notify by > Active webhook.
  4. Select the webhook you created to replace the target from the dropdown.
  5. Configure the webhook to send the information you need to.

    For example, if replacing a URL target, under URL parameters, you'd do the following:

    • Set the key to the URL target's Attribute name.
    • Set the value to the Notify by > Target action's Message.
  6. Click Save.
  7. Return to the webhook and test the functionality.

Deactivate your target and associated triggers

After you create the webhook and update the associated trigger, thoroughly test the webook by initiating the appropriate trigger conditions. While the trigger is configured with two Notify by actions, one for the target and another for the webhook, you should receive duplicate messages on your external application or system.

After you confirm the webhook and trigger are working properly, edit the trigger to remove the Notify by > Target action and then deactivate or delete your target.

Powered by Zendesk