Configure SMS Custom Webhooks

Setup a custom SMS keyword webhook to respond to mobile-originated messages.

As a part of this process, Airship issues a Validation Code. You will not be able to enable your webhook until you configure it to respond to GET requests to a /validate endpoint with a validation_code key containing this value.

  1. Open your messaging project and go to Settings » Channels » SMS Webhooks.
  2. Click   Configure New SMS Webhook.
  3. Enter a name for the webhook. This is just a friendly name to help you recognize your webhooks in Airship.
  4. Enter the Webhook URL. This is the base URL of your webhook server. Your webhook server is expected to support <base Url>/validate and <base URL>/inbound-sms endpoints.
  5. Select the Authentication mechanism for your webhook.
    • Basic: Enter the Username and Password that Airship will use to authenticate with your webhook server.
    • Signature: Enter the Secret Key that Airship will use as a part of an X-UA-SIGNATURE header to authenticate with your webhook server.
  6. Click Save. Airship issues a Validation Code. Before you enable the webhook, you must configure your webhook provide a confirmation_code containing this value in a 200 response to a GET request to your webhook server's /validate endpoint.
  7. After you have setup your webhook to respond with the validation code, select Enabled to enable the webhook, then click Update.

When you enable the webhook, Airship issues a request to your webhook's /validate endpoint. If successful, your webhook will begin receiving requests at the /inbound-sms endpoint. Contact your Airship account manager to determine the keywords you want to route to your webhook server.

Enable or Disable an SMS Webhook

Before you disable a webhook, check with your Airship account manager to make sure that you aren't sending any keywords to the webhook.

  1. Open the project containing your webhook and go to Settings » Channels » SMS Webhooks.
  2. Click Edit for the webhook you want to enable or disable.
  3. Select or clear the Enabled box. When enabling a webook, Airship will test your webhook's /validate endpoint to ensure that it returns the validation code for the webhook.
  4. Click Update.

Edit an SMS Webhook

  1. Open the project containing your webhook and go to Settings » Channels » SMS Webhooks.
  2. Click Edit for the webhook you want to modify.
  3. Make your changes and click Update.