Build a webhook

Learn how to build a webhook that will use a PureCloud to integrate with a third-party system.

Prerequisites

• Configure the following permissions in PureCloud:
  • Integrations > Integration > Add, Delete, Edit, View permissions
  • Integrations> Action > Add, Delete, Edit, Execute, View permissions
  • Journey > Action Template > Add, Delete, Edit, View permissions
• Prepare a PureCloud integration for use with an Altocloud webhook.

For more information on the PureCloud permissions, see Requirements for the data actions integration.

Create a webhook

To create a webhook, start in the action library.

Tip

If a similar webhook already exists, you can duplicate it instead.

1. Admin > Altocloud > Action Library.
2. Click the Webhook tab.
3. Click Create webhook.
4. Provide a meaningful name and description.
5. Select the integration you created in PureCloud.
6. Select the data action.
7. For each data action input contract value field, create a mapping that specifies where the field's value comes from. Use hard-coded, static values or use dynamic lookups to map real-time data about customers.
   
   Important

   You must map all fields defined for the integration's input contract.
   
   
8. Do one of the following:
   • Click Save as draft if the webhook is not ready for use with action maps.
   • Click Save and publish if the webhook is ready for use with action maps.
     
     Important

     After you publish a webhook, you can no longer edit it. You can, however, archive it if you no longer need it.

Dynamic lookups

Each data action populates one or more data fields in the backend system. You need to map each of these data fields to the source of the data from Altocloud. You can either provide a hard-coded value or use a dynamic lookup.

Remember, the webhook will be triggered by an action map, and that action map will be triggered because a user with specific characteristics or behaviors is on your website. To capture the specific data about that particular user, use dynamic lookups.

Important

• You must map all fields defined for the integration's input contract.
• There is no way to verify that the dynamic lookup you select will have a corresponding mapped value at the time when the data action is executed. The data action will be executed in any case.

To see the full list of available dynamic lookups, click the following links:

• Dynamic lookups for customer data

• Dynamic lookups for session data

Use the webhook with an action map

1. Build an action map.
2. Under Select action, click Configure.
3. Click Webhook and then click Next
4. Select the webhook you want and click Next.
5. Select how and when the webhook will work.
6. Click Finish.

Important

By default, when you create an action map it is automatically active when you save it. This is important because the action map must be active in order for the webhook to work properly.

Go-live checklist

When you are ready to go live with your webhook, verify the following items:

• Is the webhook action (action template) published?
• Is the action map that uses the webhook active?
• Is the PureCloud integration that is assigned to the action template active?
• Is the PureCloud data action saved and published?
  

After you go live, monitor your webhook's performance. If you encounter difficulties with your webhook, see Troubleshoot webhooks.