Register a webhook endpoint

POST

/webhooks

The endpoint's signing secret is included in this response only; it
cannot be read again later, but can be rotated at any time. An app may
hold a small fixed number of endpoints (403 when exceeded), and an
approved app needs a Synci plan first (402).

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠422ValidationException

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.synci.io/api/v1/webhooks' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "http://example.com",
    "description": "string",
    "enabled": true,
    "events": [
        "transactions.created"
    ],
    "omit_sensitive_identifiers": true,
    "financial_accounts": "string",
    "payload_version": "string",
    "type": "string"
}'

Response Example

200 - Example 1

{}

Modified at 2026-09-07 21:54:11

List your webhook endpoints

Show a webhook endpoint