Webhooks

List all webhook endpoints

The webhook endpoints registered by the authenticated user. Signing secrets are not included — they are only returned on creation and rotation. OAuth apps see only the endpoints they created themselves.

GET

/webhooks

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

{
  "data": [
    {
      "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>"
    }
  ],
  "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.

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

Response

Paginated set of WebhookEndpointResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team