Webhook Logs
API resource for viewing Webhook Request Logs.
GET /webhook_logs
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/webhook_logs
List Webhook Logs.
Lists Outgoing Webhook request logs, records of webhooks fired to buyers or integrations, with their related lead and call. Uses cursor-based pagination, enforces a maximum date range, and requires the webhook_logs permission.
Params
| Param name | Description |
|---|---|
|
ids Optional |
Return records matching these ids.
|
|
page Optional |
Return the next page of results. A per_page request parameter > 10 is not allowed, cursor must be used instead.
|
|
cursor Optional |
The API provides a technique called ‘cursoring’ to paginate large result sets. Cursoring separates results into pages (the size of which are defined by the per_page request parameter) and provides a means to move backwards and forwards through these pages. To retrieve cursored results, you initially pass a cursor with a value of -1 to the endpoint. By default, an API endpoint that supports cursoring will assume -1 was passed as cursor if you do not provide one. The response to a cursored request will contain metadata.next_cursor. The next_cursor is the cursor that you should send to the endpoint to receive the next batch of responses. You will know that you have requested the last available page of results when the API responds with a next_cursor = 0.
|
|
per_page Optional |
How many results to return per page. The default is 25.
|
|
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
|
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
|
fulltext Optional |
Search for any record that matches this text
|
|
time_zone Optional |
Date ranges will be parsed using this time zone.
|
|
columns Optional |
Specify the columns you would like returned by the API for a given resource.
Limiting the columns can significantly increase API response time since only the requested data will be processed.
columns=uuid,number,created_at
Must be any combination of:
|
|
root Optional |
Pass
|
GET /webhook_logs/:id
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/webhook_logs/:id
Show A Webhook Log.
Fetches a single Outgoing Webhook log entry by id, showing the details of that webhook attempt. Requires the webhook_logs permission.