GET
/
webhooks
/
{webhook_id}
/
events
List webhook events
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/webhooks/{webhook_id}/events \
  --header 'Authorization: Bearer <token>'
{
  "next_page_token": "a8937a0d",
  "event_list": [
    {
      "event_resource": "<string>",
      "event_resource_changed_fields": "<string>",
      "event_time": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": "<string>",
      "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "response_history": [
        {
          "code": 123,
          "response_body": "<string>",
          "response_time": "2023-11-07T05:31:56Z",
          "sent_time": "2023-11-07T05:31:56Z"
        }
      ],
      "status": "FAILED",
      "type": "ACCOUNT.CREATED",
      "url": "<string>",
      "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
webhook_id
string<uuid>
required

Webhook ID

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

Query Parameters

​
start_time
string<date-time>

Start time of date-time range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.

​
end_date
string<date>
deprecated

End date of date range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.. end_date is alias of end_time and is deprecated. Please use end_time instead.

​
end_time
string<date-time>

End time of date-time range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
resource_id
string<uuid>

Limit returned events to those that occurred on the specified resource.

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
start_date
string<date>
deprecated

Start date of date range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.. start_date is alias of start_time and is deprecated. Please use start_time instead.

Response

List of webhook events

​
event_list
Webhook event · object[]
required

Array of events

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"