SIsignnow

Get list of callbacks

This endpoint allows API users to get the history of webhook callbacks sent for their event subscriptions. Each item contains the event, the callback request and the response returned by the callback URL.

Notes

  • The results can be filtered and sorted with the filters and sort query parameters.
  • If sort is not set, the results are sorted by start_time in descending order.
  • The results are paginated. Use the links in meta.pagination.links to get the adjacent pages.
get/v2/event-subscriptions/callbacks

Request

Query parameters

Sort results by the end time. Possible values: asc, desc. Format: ?sort[end_time]=desc

Sort results by the start type. Possible values: asc, desc. Format: ?sort[start_time]=desc

Sort results by the response code. Possible values: asc, desc. Format: ?sort[code]=desc

Sort results by the specific type of event (from A to Z). Possible values: asc, desc. Format: ?sort[event]=desc

Sort results by the application name (from A to Z). Possible values: asc, desc. Format: ?sort[application]=desc

Search for a string in entity IDs, callback URLs, and initiator IDs. Format: ?filters=[{"_OR":[{"entity_id":{"type":"like","value":"21a28b47"}},{"callback_url":{"type":"like","value":"21a28b47"}},{"initiator_id":{"type":"like","value":"21a28b47"}}]}]

Filter results by the timestamps. Format: ?filters=[{"date":{"type":"between","value":[1580719773,1580720509]}}]

Filter results by the response codes. Format: ?filters=[{"code":{"type": "between", "value":[199,299]}}]

Filter results by the specific type of event. Format: ?filters=[{"event":{"type": "in", "value":["document.create", "document.update"]}}]

Filter results by the event type. Possible values: 'user', 'document', 'document_group'. Format: ?filters=[{"event_type":{"type": "in", "value":["user", "document", "document_group"]}}]

Filter results by the application. Format: ?filters=[{"application":{"type": "in", "value":["applicationUniqueId1", "applicationUniqueId2"]}}]

Request body

object required

Response

Returns a paginated list of callback requests sent for the user's event subscriptions, with request and response details for each.

Changes

No recorded changes to this operation across all 1 revision of this API.