Webhooks

List all webhook events

The delivery log for your webhook endpoints: one entry per delivery attempt, with the outcome. Use include=payload to include the delivered payload in each event.

GET

/webhooks/events

curl --request GET \
  --url https://api.synci.io/api/v1/webhooks/events \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "attempt": "<string>",
      "created_at": "<string>",
      "error": "<string>",
      "event_id": "<string>",
      "event_type": "<string>",
      "id": "<string>",
      "payload": "<string>",
      "sensitive_identifiers_omitted": "<string>",
      "status_code": "<string>",
      "success": "<string>",
      "updated_at": "<string>",
      "webhook_endpoint": {
        "created_at": "<string>",
        "description": "<string>",
        "enabled": "<string>",
        "events": "<string>",
        "financial_accounts": "<string>",
        "health": {
          "failure_count": "<string>",
          "integrator_message": "<string>",
          "last_attempt_at": "<string>",
          "status": "<string>",
          "transient_failure_count": "<string>",
          "transient_message": "<string>"
        },
        "id": "<string>",
        "omit_sensitive_identifiers": "<string>",
        "payload_version": "<string>",
        "secret": "<string>",
        "type": "<string>",
        "updated_at": "<string>",
        "url": "<string>"
      },
      "webhook_endpoint_id": "<string>"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "links": [
      {
        "active": true,
        "label": "<string>",
        "url": "<string>"
      }
    ],
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

page[size]integerquerydefault:25

The number of results that will be returned per page.

page[number]integerquery

The page number to start the pagination from.

filter[id]stringquery

Only the event with the given ID.

sortenum<string>[]querydefault:["-id"]

includeenum<string>[]query

filter[event_type]enum<string>query

Only events of the given event type.

Available options: transactions.created, transactions.updated, balance.updated, holdings.updated, account.created, account.updated, account.deleted, bank_account.created, bank_account.updated, bank_account.deleted, connection.created, connection.activated, connection.reauthorized, connection.expiring, connection.expired, connection.failing, connection.recovered, connection.disabled, connection.deleted, portal.user.verified

filter[webhook_endpoint_id]integerquery

Only events delivered to the given webhook endpoint.

filter[success]booleanquery

Only successful (true) or failed (false) deliveries.

filter[status_code]integerquery

Only deliveries that received the given HTTP status code.

Response

Paginated set of WebhookEventResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team