Update webhook endpoint

PUT

/webhooks/{webhookEndpointId}

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).

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

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

Authorize URL: https://api.synci.io/oauth/authorize

Token URL: https://api.synci.io/oauth/token

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠401AuthenticationException

🟠403AuthorizationException

🟠404ModelNotFoundException

🟠422ValidationException

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

Modified at 2026-07-14 16:18:50

Get webhook endpoint

Delete webhook endpoint