v4

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-15152735.4 KB

webhooks

Test OAuth connection

Tests the OAuth client credentials configuration for a saved webhook by attempting a token exchange against the configured OAuth endpoint. Returns success with token metadata (e.g. expires_in, token_type) or an error describing why the exchange failed. Does not send the actual webhook.

post/v1/webhooks/configs/{configId}/test-oauth

Path parameters

configIdstring required

Short uuid to identify the webhook configuration.

Response

OAuth token exchange succeeded

successboolean required

Whether the OAuth token exchange succeeded

expires_innumber

Token validity in seconds as reported by the OAuth provider

token_typestring

Token type returned by the OAuth provider

messagestring required

Human-readable result message

Example response

{
  "success": true,
  "expires_in": 3600,
  "token_type": "Bearer",
  "message": "OAuth token exchange successful"
}