webhook-tasks

List webhook tasks

SecurityapiAuth

Request

query Parameters

completed	string or null <date-time>
completed__gt	string or null <date-time>
completed__gte	string or null <date-time>
completed__isnull	boolean
completed__lt	string or null <date-time>
completed__lte	string or null <date-time>
created	string <date-time>
created__gt	string <date-time>
created__gte	string <date-time>
created__lt	string <date-time>
created__lte	string <date-time>
failed	string or null <date-time>
failed__gt	string or null <date-time>
failed__gte	string or null <date-time>
failed__isnull	boolean
failed__lt	string or null <date-time>
failed__lte	string or null <date-time>
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
updated	string <date-time>
updated__gt	string <date-time>
updated__gte	string <date-time>
updated__lt	string <date-time>
updated__lte	string <date-time>
webhook	integer
webhook__event	string
webhook__secret	string
webhook__url	string

Responses

200

get/3/admin/webhook-tasks/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"webhook": {"id": 0,
"url": "http://example.com",
"event": "company.link.create",
"secret": "string",
"condition": "string",
"enabled": true,
"service": {"id": 0,
"slug": "string",
"name": "string",
"url": "string",
"type": "system"
},
"archived": false,
"created": 0,
"updated": 0
},
"tries": 0,
"completed": 0,
"failed": 0,
"archived": true,
"created": 0,
"updated": 0
}
]
}
}

Retrieve webhook task

SecurityapiAuth

Request

path Parameters

webhhook_task_id

required

string^\d+$

Responses

200

get/3/admin/webhook-tasks/{webhhook_task_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"webhook": {"id": 0,
"url": "http://example.com",
"event": "company.link.create",
"secret": "string",
"condition": "string",
"enabled": true,
"service": {"id": 0,
"slug": "string",
"name": "string",
"url": "string",
"type": "system"
},
"archived": false,
"created": 0,
"updated": 0
},
"tries": 0,
"completed": 0,
"failed": 0,
"archived": true,
"created": 0,
"updated": 0,
"data": {"property1": null,
"property2": null
}
}
}

List webhook task requests

SecurityapiAuth

Request

path Parameters

webhhook_task_id

required

string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
response_code	integer

Responses

200

get/3/admin/webhook-tasks/{webhhook_task_id}/requests/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"response_code": 0,
"error": "string",
"archived": true,
"created": 0,
"updated": 0
}
]
}
}

Retrieve webhook task request

SecurityapiAuth

Request

path Parameters

webhhook_task_id required	string^\d+$
webhook_request_id required	string^\d+$

Responses

200

get/3/admin/webhook-tasks/{webhhook_task_id}/requests/{webhook_request_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"response_code": 0,
"error": "string",
"archived": true,
"created": 0,
"updated": 0
}
}

➔ Next to webhooks