Configure Open Channels

Add Open Channels to your project, or edit an existing configuration.

 Important

Open Channels configuration requires your webhook URL. See: Set Up Your Webhook Server.

  1. Open your messaging project and go to Settings » Channels » Open Channels.
  2. Click + Configure New Open Channel and complete the form. All fields are required.
    • Name: Enter a name indicative of the platform, e.g., slack or sms. This is the canonical name that will be used for programmatic use through our API. 20-character maximum. A-Z, a-z, 0-9, _, and - only.
    • Display Name: Enter a user-friendly name for the channel, e.g., "Alexa," "Smart Toaster Dev." This is the name of the channel as it will appear in the Airship dashboard.
    • Webhook URL: Enter the URL + path to which we will deliver message payloads, e.g., https://acme-toaster.appspot.com/api/channels/production.
    • Authentication: Select the authentication mechanism for your webhook server.
      • None
      • Basic: Enter the username and password for the webhook server.
      • Signature Hash: Enter a secret key for use as a part of the X-UA-SIGNATURE header. See Signature Hash and Security for more information.
  3. Click Save. After saving, a Validation Code field appears, containing a 36-character UUID. This code must be returned by the webhook server at <webhook_root>/validate. See: Set Up Your Webhook Server.
  4. Check the Enabled box to enable the open channel for use, then click Update.
 Note

We do not validate the endpoint until you enable and save the configuration. We will revalidate it each time you update the configuration, as long as it remains enabled.

Enable or Disable Open Channels

  1. Open your messaging project and go to Settings » Channels » Open Channels. Each open channel is listed by its configured Display Name followed by its canonical Name, newest channels first. Disabled channels appear greyed-out.
  2. Click Edit for the channel you want to enable or disable.
  3. Check or uncheck the Enabled box.
  4. Click Update.

Edit or Delete Open Channels

  1. Open your messaging project and go to Settings » Channels » Open Channels. Each open channel is listed by its configured Display Name followed by its canonical Name, newest channels first. Disabled channels appear greyed-out.
  2. Click Edit.
  3. Make your changes and click Update, or click remove this service.