The goal of this tutorial is to show admins how they can use Upmarket Webhoooks to send events and data payloads from Upmarket to downstream systems of record like CRMs easily.
Role
Admin
How To Configure a New Webhook
Select Settings from the Toolbar
Click Webhooks under Integrations
Click Create Webhook
Enter a Webhook Name and click Create
Enter the webhook/listener URL in the Endpoint field.
Make sure that this is a HTTP POST endpoint and it should return HTTP 200 OK. This URL must be secured over HTTPS.
Select the event type from the Event drop down
ex: Call Interactions
Check Create/Update/Delete toenable the type of event to be notified on
A green window will appear confirming you have successfully created a Webhook
Click on the Verification Key to copy the verification key to clipboard or click Generate to generate a new verification key
Use the copied verification key to to verify whether the event notifications that you receive originate from Upmarket, which will be available in request header as x-verification-key
Create a Username and Password to add basic authentication for the provided Webhook Endpoint URL
Click Create to publish the Webhook
Add Authentication for Webhook Endpoint (Optional)
If the downstream system requires every request to be authenticated with a user/password, you can add the authentication here.
Select Settings from the Toolbar
Click Webhooks under Integrations
Click on an existing Webhook or create a new Webhook.
Create a Username and Password to add basic authentication for the provided Webhook Endpoint URL
Click Save after any changes made to existing an Webhook
Using a Verification Key (Optional)
You can add a verification key to every outbound request from Upmarket to verify that the data received by the downstream is in fact from Upmarket. This step is recommended, but is optional.
Select Settings from the Toolbar
Click Webhooks under Integrations
Click on an existing Webhook or create a new Webhook.
Click on the Verification Key to copy the verification key to clipboard or click Generate to generate a new verification key
Click Save after any changes made to existing an Webhook
Use the copied verification key to to verify whether the event notifications that you receive originated from Upmarket. The key will be available in request header as x-verification-key
To verify that the request was sent from upmarket please compare the x-verification-key header value with the one you received in the above step.