Adding a Webhook for notifications

Get notitifications of events happening in your DialogForm account.

This feature is still under construction

We are working on a set of API endpoints where you will be able to use the notification data sent to your webhook to retrieve complete details of the event that occurred. This will allow you to create your own automations on top of what DialogForm offers out of the box.

Available notifications

1. Chat completed

This notification is sent when a user completes a chat.

// The following JSON data is sent
// * `identifier` - The user identifier provided in the share link
// * `flowId` - Self explanatory
// * `score` - The user's score, if any
{
  "type": "completed",
  "data": {
    "flowId": number,
    "identifier": string,
    "score": number or null
  }
}

2. Chat deleted by admin

This notification is sent when a chat is deleted via the admin panel.

// The following JSON data is sent
// * `identifier` - The user identifier provided in the share link
// * `flowId` - Self explanatory
{
  "type": "deleted",
  "data": {
    "flowId": number,
    "identifier": string
  }
}

3. Admin provides some feedback on a user response

This notification is sent when feedback is provided on a user response in a chat history via the admin panel.

// The following JSON data is sent
// * `identifier` - The user identifier provided in the share link
// * `flowId` - Self explanatory
// * `promptName` - The particular prompt for which feedback was given
{
  "type": "feedbackUpdated",
  "data": {
    "flowId": number,
    "identifier": string,
    "promptName": string
  }
}

Adding a Webhook

1. On https://admin.dialogform.in (on the home page), click on your account avatar on the top right, and navigate to 'Integrations' to open up the Integrations page
2. Select the 'Webhook' tab in the left panel

3. Enter a URL (including the protocol) into the input field. DialogForm will send notifications by making HTTP POST requests to this URL.