Webhooks

Configuring webhooks allows your server to be notified when ALO actions are created and updated. Updates include status and assignment changes. You will also receive a requests when a chat message has been created in ALO that is associated with an action.

With this and use of the ALO Platform API you will have the capability of keep data in sync with ALO and your external systems.

Webhook Settings

To setup webhooks select the Webhooks section on the App setting page.

Toggle the switch from Disabled to Enabled.

Once enabled you will be presented with a form where you are to provide the Url to you server where you would like the ALO webhook requests to go.

Your server will send a challenge request to you server for validation. The payload send to your server will look something like the following:

{
    "challenge": "cad3d673-4965-44ae-b536-647142df97a7",
    "type": "webhook_url_verification"
}

Once you server received the request it must verify the request's authenticity. See Verifying Requests from ALO.

Once verified your server must response with a status of 200 and JSON payload contain the challenge value it received. The response payload should look like this:

HTTP 200 OK
Content-type: application/json
{"challenge":"cad3d673-4965-44ae-b536-647142df97a7"}

Webhook Types

There are several types of data the ALO will send via webhook. The payload of the webhook request will contain one of the following types:

Value	Description
webhook_url_validation	As described above, a request of this type is used to validate the webhook url you have provided in the Webhook Settings
action_created	A new action has been created in ALO.
action_updated	An existing ALO action has been updated. This might be action form data updates
action_status_updated	The status of an action has been changed. For example, it was changed from Doing to Completed
action_assignment_changed	The user(s) assigned to an action has been changed
action_message_added	A message related to an existing action has been created

Webhook Payloads

Each webhook type will have a specific payload structure.

webhook_url_validation

{
    "challenge": "cad3d673-4965-44ae-b536-647142df97a7",
    "type": "webhook_url_verification"
}

action_created

// TBD

action_updated

// TBD

action_status_changed

// TBD

action_assignment_changed

// TBD

action_message_added

// TBD