Create new webhook endpoint

POST

/webhooks

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Body

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.synci.io/api/v1/webhooks' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://example.com",
    "description": "string",
    "enabled": true,
    "type": "WEBHOOK",
    "omit_sensitive_identifiers": true,
    "events": [
        "transactions.created"
    ],
    "bank_accounts": [
        0
    ]
}'

Response Example

201 - Example 1

{
    "message": "Webhook endpoint created.",
    "data": {
        "id": 0,
        "url": "string",
        "description": "string",
        "enabled": true,
        "type": "WEBHOOK",
        "omit_sensitive_identifiers": true,
        "events": [
            null
        ],
        "bank_accounts": [
            null
        ],
        "health": {
            "status": "HEALTHY",
            "integrator_message": "string",
            "failure_count": 0,
            "last_attempt_at": "2019-08-24T14:15:22.123Z"
        },
        "secret": "string",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-02-12 21:58:29

List all webhook endpoints

Get webhook endpoint