Sign in
Webhooks

Verify a webhook endpoint

Send a test event to verify the webhook endpoint is properly configured and reachable. The request body accepts an optional 'eventType' field to specify which event type to test (e.g., 'transaction.created', 'transaction.updated'). If omitted from the request body, defaults to 'transaction.created'.

post/webhooks/{webhookEndpointId}/verify

Path parameters

webhookEndpointIdstring uuid required

ID for the webhook

Request body

eventType'transaction.created' | 'transaction.updated' | 'checkingAccount.balance.updated' | 'savingsAccount.balance.updated' | 'treasuryAccount.balance.updated' | 'investmentAccount.balance.updated' | 'creditAccount.balance.updated' nullable

Optional event type to test. If not specified, defaults to transaction.created.

Changes

Changed in 1 of the 45 revisions of this API.11

  • 57d0bcefe5d111See the full diff
    • ▲

      removed the success response with the status 200

      response-success-status-removed

    • ○

      added the success response with the status 204

      response-success-status-added