Webhooks

Webhooks, also called a web callback or HTTP push API, are the API concepts that are getting more and more popular. Thanks to their lightweight and speed they provide data between applications immediately. With webhooks, you can pass and retrieve information from a matched interaction to your web service.

List all Webhooks

Returns list of all created webhooks.

Properties

Request URL

curl --request GET \
	--url https://api.chatbot.com/webhooks \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}'

Response Example

[
    {
        "id": "5a21a9e21ec94a0007f9ac19",
        "name": "Webhook",
        "url": "https://example.com",
        "error": ""
    }
]

Get a specific webhook

Returns a specific webhook object.

Request URL

curl --request GET \
	--url https://api.chatbot.com/webhooks/:ID \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}'

Response Example

{
    "id": "5a21a9e21ec94a0007f9ac19",
    "name": "Webhook example",
    "url": "https://example.com",
    "token": "qwerty",
    "headers": [],
    "auth": {
        "username": "",
        "password": ""
    },
    "error": {
        "date": "2017-12-04T15:06:12.053Z",
        "message": "timeout of 10000ms exceeded"
    }
}

Properties

Create a webhook

Creates a new webhook.

curl --request POST \
	--url https://api.chatbot.com/webhooks \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json' \
	--data '
{
    "name": "Webhook name",
    "url": "${WEBHOOK-URL}",
    "token": "",
    "headers": [],
    "auth": {}
}
'

Request URL

Response Example

{
    "id": "58ee2e085d033800059a3f7f",
    "timestamp": "2018-01-12T13:40:40.260Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}

Properties

Update a webhook

Updates a webhook.

Request URL

curl --request PUT \
	--url https://api.chatbot.com/webhooks/:ID \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json' \
	--data '
{
    "name": "Webhook name",
    "url": "${WEBHOOK-URL}",
    "token": "",
    "headers": [],
    "auth": {}
}
'

Response Example

{
    "id": "58ee2e085d033800059a3f7f",
    "timestamp": "2018-01-12T13:40:40.260Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}

Properties

Delete a webhook

Removes a webhook.

curl --request DELETE \
	--url https://api.chatbot.com/webhooks/:ID \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json'

Request URL

Response Example

{
    "id": "58ee2e085d033800059a3f7f",
    "timestamp": "2018-01-12T13:40:40.260Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}

Common object definitions

headers

Array of request headers.

auth

Webhook integration examples

Don’t know how to setup your first ChatBot webhook? Check it here or get our ready to use examples:

• Node.js without any libraries
• Node.js using express + body-parser
• PHP
• Firebase example