Skip to main content

Webhooks

You can setup optional webhooks in the Custom Channel Dialog to receive webhook requests from Askribe. These webhooks serve a variety of purposes:

  • Start a new session
    • Usually, your system wants to start a new session for your user. For this you wil use our Custom Channel APIs in which case your system ASKS Askribe to start a new flow
    • But in many cases, Askribe will TELL you to start a flow. This happens when you
      • Use Manually Triggered Distribtion to distribute a flow via a custom channel
      • Have setup a scheduler to run the flow at a future point in time
      • Have setup the flow to be triggered via Webhook Triggers
    • In such cases, our system will make a POST call to your preconfigured webhook URL. The body of the request is the same as the response of Custom Channel Start Flow API
  • Transition to Custom Channel Advanced
    • Let's suppose you have created a cross-channel flow (channel transition enabled) with one of the channels being your custom channel and then distributed it via a pre-defined channel
    • Once our execution engine reaches a block that is configured to transition to your custom channel, our system will TELL your system to render a block for your user.
    • In such cases, our system will make a POST call to your preconfigured webhook URL. The body of the request is the same as the response of Custom Channel Start Flow API