Automations

Rotate webhook URLs

Give a webhook trigger (triggerRef), or every one, of an active automation a new URL; the old one stops at once. Not idempotent: every call mints again. The URLs are in webhooks, once — store them.

post/v1/automations/{automationId}/webhooks/rotate

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/automations/{automationId}/webhooks/rotate
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

automationIdstring required

Automation ID

Headers

Idempotency-Keystring

Makes a retry safe: the same key with the same request replays the first answer for 24 hours instead of running twice, and the same key with a different request is a 409 IDEMPOTENCY_KEY_REUSED. Refusals a retry can outlive — 408, 409, 423, 425, 429 and every 5xx — are never replayed, so retrying with the same key after the cause clears runs the request.

Request body

triggerRefstring

One webhook trigger, by ref; leave it out to rotate every webhook.

Response

The new URLs

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.