How to Use Webhooks?

Webhooks are a fantastic way to extend the Botgate AI platform beyond the built-in feature set.

You can use 8 events for your Webhooks:

  • conversation:start
  • conversation:open
  • conversation:join
  • conversation:left
  • conversation:close
  • message:appUser
  • message:appMaker
  • postback

What are these events?

Now let's explain what these events mean:

The "conversation:start" event is triggered when the end-user starts a new conversation.

The "conversation:open" event is triggered when the end-user connects to live chat (no participants).

The "conversation:join" event is triggered when the teammate joins the conversation.

The "conversation: left" event is triggered when the teammate leaves the conversation.

The "conversation: close" event is triggered when the conversation is closed by a teammate or automatically.

The "message:appUser" event is triggered when the end-user sends messages to the bot or the teammate within a conversation.

The "message:appMaker" event is triggered when the end-user receives messages within a conversation.

The "postback" event is triggered when the information requested by the end-user is answered.

How to add Webhooks?

  1. Let's go to Botgate AI Dashboard > Integrations and click on Webhooks.

    botgate-integrations-webhooks
  2. You will see the list of events that are mentioned above. Scroll down and click on Add Webhook.

    botgate-integrations-add-webhooks

    Enter your endpoint, select the events you want to use, and click on Save. If you want to delete it, just click on Delete.

Want to have more information on this? You can check our Webhook documentation just by clicking View Documentation on the top right or here!