To Get the List of Failed Executions
Description:
You can use this API to get the list of execution failed for a particular webhook in your portal.
Note:
- The executions with response code greater than or equal to 300 will be considered as failures.
- Timeout per execution is 5 seconds.
- If failed, we'll retry again in 1 minute and this will be done thrice after which the executions are added as failed executions.
Query Parameters:
- from_time, to_time - To fetch the failed executions between the given time range.
- events - To fetch the failed executions for the given events alone.
- limit - The number of failed executions that should be retrieved and listed, the minimum limit is 5 and maximum is 50. By default, the limit is set to 50. If no limit is set then the default limit will be considered.
- pageno - To get the list of failed executions from a particular page. If the given page number doesn't have any data, then an empty array will be returned.
OAuth Scope:
SalesIQ.webhooks.READ
URL:
Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/webhooks/{id}/executionsExample:
Copiedhttps://salesiq.zoho.com/api/v2/zylker/webhooks/19367000000120011/executions?pageno=1&limit=10&events=conversation.created,conversation.endedSample Response:
Copied{
"url": "/api/v2/zylker/webhooks/19367000000120011/executions?pageno=1&limit=10&events=conversation.created,conversation.ended",
"object": "list",
"data": [
{
"event": "conversation.operator.replied",
"remote_server_status": 400,
"id": "0db0d4d5-f4ae-4cb2-9ee4-990c171cddab",
"number_of_retries": 3,
"entity_id": "19367000000130079",
"entity": "conversation",
"entity_label": {
"id": "19367000000130079"
},
"app_id": "19367000000002043",
"webhook_id": "19367000000120011",
"payload": {
"version": 1,
"event_time": "1566841905380",
"message": {
"sender": {
"name": "Tricia",
"id": "19367000000002079"
},
"msgid": "1566841905333",
"text": "sargunamdurairaj"
},
"id": "19367000000130079"
},
"last_execution_time": "1566842025533"
},
{
"event": "conversation.operator.replied",
"remote_server_status": 400,
"id": "9cc32d72-9a7f-483b-a6f6-d5c4ae2a9ab8",
"number_of_retries": 3,
"entity_id": "19367000000130035",
"entity": "conversation",
"entity_label": {
"id": "19367000000130035"
},
"app_id": "19367000000002043",
"webhook_id": "19367000000120011",
"payload": {
"version": 1,
"event_time": "1566841810782",
"message": {
"sender": {
"name": "LD_54045592_b19367000000103009",
"id": "19367000000103009"
},
"list": [
{
"msgid": "1566841810773",
"time": "1566841810773",
"meta": {
"version": 1,
"hand_off": true,
"typing_delay": 0
},
"msg": "Don't worry. Help is on the way",
"mtype": 12
},
{
"msgid": "1566841810774",
"time": "1566841810774",
"meta": {
"suggestions": [
"Reading",
"Listening",
"Writing"
],
"version": 1,
"hand_off": true,
"typing_delay": 0
},
"msg": "Which areas are you trying to improve?",
"mtype": 12
}
]
},
"id": "19367000000130035"
},
"last_execution_time": "1566841930949"
},
{
"event": "conversation.operator.replied",
"remote_server_status": 400,
"id": "77abe437-5b35-4bf8-be05-52c3cd45bd26",
"number_of_retries": 3,
"entity_id": "19367000000130035",
"entity": "conversation",
"entity_label": {
"id": "19367000000130035"
},
"app_id": "19367000000002043",
"webhook_id": "19367000000120011",
"payload": {
"version": 1,
"event_time": "1566841804959",
"message": {
"sender": {
"name": "LD_54045592_b19367000000103009",
"id": "19367000000103009"
},
"list": [
{
"msgid": "1566841804948",
"time": "1566841804948",
"meta": {
"version": 1,
"hand_off": true,
"name": "mode",
"typing_delay": 0,
"context_id": "context"
},
"msg": "Got it",
"mtype": 12
},
{
"msgid": "1566841804949",
"time": "1566841804949",
"meta": {
"suggestions": [
"online",
"offline"
],
"version": 1,
"hand_off": true,
"name": "mode",
"typing_delay": 0,
"context_id": "context"
},
"msg": "How would you like to take the classes?",
"mtype": 12
}
]
},
"id": "19367000000130035"
},
"last_execution_time": "1566841925391"
}
],
"sync_time": "1566888685958"
}