FAQ Developers

Using Circuit

Circuit administration

Subscriptions

Adding an incoming webhook in a conversation

Last updated:

You can create an incoming webhook in a conversation to allow external apps to post messages to a Circuit conversation to notify participants about certain events. Messages can be posted on your behalf or on behalf of a bot user.

Prerequisites:

The Circuit domain administrator has to enable the Incoming Webhooks integration through the Manage applications > Apps tab.

  1. On the web client and Desktop App, select a conversation and then navigate to > Apps.
  2. Click Add new app.
  3. In the Add incoming webhook window, do the following:
    1. Enter a name for the incoming webhook.
    2. If the domain administrator has created and enabled bots for incoming webhooks, you can select a bot from the drop-down list to appear as the author of the messages. If no bot is selected, messages will be posted on your behalf.

      The option to select a bot is hidden if no bot is enabled on the domain.

    3. Click Create.
  4. In the Incoming webhook URL window, click Copy to clipboard and, then, click Close.

    Copy this URL to the external app that will be posting the messages.

    If you want to copy again the webhook URL, hover over the app and click Edit > Copy.

 

Below you may find examples on the format you can add content in the external app:

{ "text" : "This is my main text with a https://www.google.com link to Google"}

Basic formatting:

{ "text": "*bold* `code` _italic_"}

37 people found this useful.
Me too / Not at all