Webhooks

Update webhook endpoint

The payload_version field is pinned at creation and cannot be changed here. Re-enabling a disabled endpoint is subject to your plan's limit on active endpoints (403 when exceeded).

PUT

/webhooks/{webhookEndpointId}

curl --request PUT \
  --url https://api.synci.io/api/v1/webhooks/{webhookEndpointId} \
  --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>"
  },
  "message": "Webhook endpoint updated."
}

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

webhookEndpointIdintegerrequired

The webhook endpoint ID

Body

descriptionstring | null

Optional label to help you identify the endpoint.

Maximum string length: 255

enabledboolean

Whether the endpoint receives deliveries. Re-enabling is subject to your plan's limit on active endpoints.

eventsenum<string>[]

The event types this endpoint should receive. Canonical names: transactions.created, transactions.updated, balance.updated, holdings.updated, account.created, account.updated, account.deleted. Legacy aliases (bank_account.created, bank_account.updated, bank_account.deleted) are accepted but cannot be mixed in the same array with their canonical counterparts.

Minimum array length: 1

financial_accountsinteger[] | null

Limit deliveries to these financial account IDs. Omit or pass null to receive events for all accounts.

omit_sensitive_identifiersenum<string>

When true, sensitive account identifiers (IBAN/BBAN) are omitted from delivered payloads. Must be true for Zapier endpoints.

Available options: yes, on, 1, 1, true, true

typeenum<string>

WEBHOOK for a standard endpoint, ZAPIER for an endpoint used with the Zapier integration, or N8N for an endpoint registered by the Synci n8n trigger node.

Available options: WEBHOOK, ZAPIER, N8N

urlstring

The HTTPS URL that will receive event deliveries.

Maximum string length: 512

Response

dataobjectrequired

Show child attributes

messagestringrequired

Still need help? Ask the team