Get a bot's webhook logs
GET https://desk-api-{{APP_ID}}.sendbird.com/platform/v1/bots/{bot_id}/webhook_logs
Get a bot's webhook logs
Retrieves a custom bot’s webhook logs.
For more information, visit:
https://sendbird.com/docs/desk/v1/platform-api/guides/bot#2-get-a-bot-s-webhook-logs
URL Parameters
Required
bot_id- Type: int
- Description: Specifies the unique ID of the target bot.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | string | OPTIONAL: Specifies the number of results to return per page. Acceptable values are 1 to 500, inclusive. (Default: 50) | |
offset | string | OPTIONAL: Specifies the number of results to skip before retrieving the next page in the result set. This is used to adjust the starting index of the next page. (Default: 0) | |
start_date | string | OPTIONAL: Specifies a starting date that restricts the search scope to retrieve webhook logs created between start_date and end_date, in YYYY-MM-DD format. | |
end_date | string | OPTIONAL: Specifies an ending date that restricts the search scope to retrieve webhook logs created between start_date and end_date, in YYYY-MM-DD format. | |
order | string | OPTIONAL: Specifies the method to sort a list of results. Acceptable values are limited to the following:<br />- created_at: sorts by the time of webhook log creation in ascending order.<br />- -created_at (default): sorts by the time of webhook log creation in descending order.<br />- id: sorts by webhook log ID in an ascending order.<br />- -id: sorts by webhook log ID in a descending order. | |
status | string | OPTIONAL: Specifies one or more statuses of webhook logs to retrieve with a query string like status=SENT&status=RECEIVED. Acceptable values are limited to the following:<br />- SENT: Logs indicating that the webhook event is successfully sent from the Desk server to your server, which contains a customer’s message the bot received.<br />- RECEIVED: Logs indicating that the Desk server successfully received the webhook event from your server, which contains the bot’s answer to a customer’s messages.<br />- ERROR: Logs indicating that the Desk server failed to receive an HTTP 200 OK response from your server. <br />- TIMEOUT: Logs indicating that your server hasn’t replied for the time limit set by the timeoutSeconds property. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
SENDBIRDDESKAPITOKEN | string |