Documentation
Log inSign up
Start typing to search…

Assigning Webhooks

Assigning Webhooks

Assigning webhooks is done exclusively through the SMSPortal Control Panel. This page introduces the concepts of assigning webhooks to a sending channel or event producer.

Webhook Management vs Assignment

Webhook management involves the process of creating a compliant webhook that will effectively communicate event data from SMSPortal's webhook engine to the customers desired HTTP server. This is simply the management of the HTTPS communication layer between our system and your system.

Once a webhook is successfully configured, the webhook needs to be assigned to actual event producers within the SMSPortal ecosystem.

Webhook Assignment is the process of assigning the webhook communication layer to a SMSPortal feature/channel linked to sending/receiving SMS data. This enables real event data to be sent via the communication layer and is thus a critical step in using our webhook integration.

Website Sending

If you are sending SMS from the SMSPortal Control Panel and want to receive delivery status or mobile originating (i.e. replies) event data via webhooks, you can assign your created webhooks on the Profile Settings > Forwarding page.

Or follow these steps to navigate there:

  1. Navigate to ‘Settings’ on the top right-hand side menu of your control panel and click ‘Profile Settings’.
  2. Select the ‘Forwarding’ tab and click on the relevant DLR and/or MO drop-down menu to select the desired webhook endpoint.
  3. Once you have made your selection click ‘Update Settings’ to save your changes.

API Sending

If you are sending SMS through an API channel, you can receive delivery status or mobile originating (i.e. replies) event data via webhooks. Webhooks can be assigned on the API Keys page.

Or follow these steps to navigate there:

  1. Navigate to ‘Settings’ on the top right-hand side menu of your control panel, then click ‘API Keys’.
  2. Click the 3 dots in the ‘Actions’ column on the right-hand side of the API channel you wish to assign the webhook endpoints to and select 'Settings'.
  3. Select the ‘Webhooks’ tab and click on the relevant DLR and/or MO drop-down menu to select the desired webhook endpoint.
  4. Click ‘Update Settings’ to save your changes.

Short Codes

If you would like to link short code messages to a configured webhook, you can assign the webhook in the Short Codes > Setup page.

Or follow these steps to navigate there:

  1. Navigate to ‘Short Codes’ on the left-hand side menu of your control panel and click ‘Setup’.
  2. Click the ‘3 dots’ under the action column on the right-hands side for either your dedicated Short Code or Keyword and select 'Forwarding'.
  3. On this menu select the desired webhook endpoint.
  4. Once you have made your selection click ‘Save’ to save your changes.

NOTE 1: This type of webhook is assigned per short code. So if a customer utilises multiple short codes, each of them would have to be assigned to a single webhook or different webhooks.

Shortened URLs

If you would like to get user interaction data via webhooks for URLs that you have shortened in our system and sent via SMS, you can assign the webhook in Marketing Tools > URL Shorteners and then selecting the specific URL and clicking the 'Edit' button.

Or follow these steps to navigate there:

  1. Navigate to the 'Marketing Tools' tab on the left-hand side menu of your control panel and click 'URL Shorteners'.
  2. Select the specific URL to assign the webhook to in the list of available URLs. If you have no URLs available, you will first need to create one (see URL Shortening).
  3. Click the 'Edit' button in the top middle of the control panel for the applicable URL. This will take you to a page to edit details regarding that URL.
  4. In the 'Webhook' form entry item, select an available webhook or create a new one.
  5. Once you have made your webhook selection click ‘Save Changes’ to save your changes.

NOTE 2: Similarly to short codes, this type of webhook is assigned per shortened URL. So if a customer utilises multiple short URLs, each of them would have to be assigned to a single webhook or different webhooks.

Landing Pages

Landing pages offer similar functionality to short URLs. If you would like to get user interaction data via webhooks for landing pages that you have created in our system and sent via SMS, you can assign the webhook in Marketing Tools > Landing Pages and then selecting the specific landing page URL and clicking the 'Edit' button.

Or follow these steps to navigate there:

  1. Navigate to the 'Marketing Tools' tab on the left-hand side menu of your control panel and click 'Landing Pages'.
  2. Select the specific landing page to assign the webhook to in the list of available pages. If you have no landing pages available, you will first need to create one (see Landing Pages).
  3. Click the 'Edit' button in the top middle of the control panel for the applicable landing page. This will take you to a page to edit details regarding that page.
  4. On the right-hand side there is a form with a 'Webhook' entry item, select an available webhook there or create a new one.
  5. Once you have made your webhook selection click 'Save' to save your changes.

NOTE 3: Similarly to short codes and short URLs, this type of webhook is assigned per landing page. So if a customer utilises multiple landing pages, each of them would have to be assigned to a single webhook or different webhooks.

Bulk Assignment

If you are familiar with all the features in the SMSPortal Control Panel, you may want a quick and easy way to assign different types of webhooks. You can do this on the Webhooks page as follows:

  1. Select any existing webhook and click the 3 dots in the 'Actions' column.
  2. Then select 'Assign To' menu item. This will open an appropriate modal that allows you to assign that webhook to entities with your account.

Updated 21 days ago

See also