Webhooks

Rotate webhook secret

Generates a new signing secret for the endpoint. The new secret is returned once in this response and cannot be read again; the previous secret stops being used immediately.

POST

/webhooks/{webhookEndpointId}/rotate-secret

curl --request POST \
  --url https://api.synci.io/api/v1/webhooks/{webhookEndpointId}/rotate-secret \
  --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 secret rotated. Remember to update your endpoint destination with the new secret."
}

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

webhookEndpointIdintegerrequired

The webhook endpoint ID

Response

dataobjectrequired

Show child attributes

messagestringrequired

Still need help? Ask the team