Webhook - Integration

The SnapComms-Webhook integration allows you to push important messages to a Webhook service provider (e.g. Zapier, Integromat, Automate.io, Presync, etc.) from the SnapComms Content Manager. Webhooks can then be configured to forward your messages to many different apps or start a workflow process. This guide uses Zapier as an example of integration with Webhooks and will help you provision a Zapier integration via your SnapComms Content Manager.

Zapier provides a large number of integrations with popular software, including sending SMS messages, sending messages to Slack, Facebook, Twitter or Email, or trigger a Zapier Webhook to initiate other software to perform a task.
 

SnapComms - Webhook Integration Setup

Perform the following steps to enable the integration:

Sign-in to your Webhook account (In this example, we use Zapier https://zapier.com). The process is very similar for most Webhook services.

Select Webhooks by Zapier from the list of Apps.

Configure the Webhook to 'Catch' a Post/Put/Get to a Zapier URL. Copy the URL provided from the Webhook service (e.g. Zapier). The SnapComms Content Manager will use this URL to send a message to the Webhook.

Note: SnapComms to Webhook integration only works one way. You can send Webhooks from SnapComms but SnapComms can not be configured to receive Webhooks.

You will then need to configure an 'Action' within the Webhook service to use the message provided by the SnapComms Content Manager. This 'Action' can include posting to social media sites, creating a post on intranet sites such as Yammer or triggering an email, amongst others.

To complete the integration, sign-in to your SnapComms Content Manager with an administrator account.
Navigate to Management >> Integrations >> Webhooks



Note: The Publish to Webhook support is a licensed feature that gives you the ability to send SnapComms messages to alternative software using Webhooks. Please contact your SnapComms sales representative if you want this feature enabled for your SnapComms account.​

The following screen is displayed:

​

Display Name: Enter the name you want to appear in the Content Manager as the name for the Webhook.

URL: Enter the 'Catch' URL you copied earlier in this process. This URL should be the 'Catch' Webhook URL which accepts a POST message.  

Security Key: If you wish to add a layer of security to your Webhook so that it needs a security key to trigger it, you should enter one here. This will be passed through to the Webhook, which can then be configured to execute only if the security key matches; for example, in Zapier this can be set up as a ‘Filter’.
 
Make sure that the 'Enable Webhooks Integration' is enabled and click Save.
 ​

Integrations:

After enabling the integration, you can start sending messages to your Webhook application. To send a message via a webhook, toggle on the Publish to Webhook under the Delivery Options, select the Webhook provider you configured, and the message you want to send. 

When the message is published, the Content Manager will submit a POST request to the Catch Hook URL with JSON data that has the following fields:

key – the security key provided in the configuration (optional)
message – the text defined in the Delivery Options tab for the content
itemId – the unique identifier for the content sent from SnapComms
itemVersion - the version of the content sent from SnapComms
assetId -  the unique identifier for the asset type sent from SnapComms
assetType - the type of asset being sent
assetName - the name of the asset created in SnapComms
publisherId -  the unique identifier for the administrator creating the content
publisherName - the name of the administrator that published the content
publishDate - the date the content has been published
previewUrl - URL to access the preview of the content created in SnapComms

This data can then be used either directly in the receiving software or in an API call to get the full content of the message from the Content Manager.