Webhooks

Get webhook OAuth credentials

Retrieve the current OAuth 2.0 credentials configured for webhook authentication.

Note: The client secret is never returned - only the non-sensitive configuration is shown.

get/v1/webhook/oauth

Request

  • Base URL: https://api.handoff.ai
  • URL: https://api.handoff.ai/v1/webhook/oauth
  • Auth: HTTP bearer

Response

OAuth credentials retrieved successfully

clientIdstring required

OAuth client ID

tokenEndpointUrlstring uri required

OAuth token endpoint URL

scopestring nullable required

Space-separated OAuth scopes

audiencestring nullable required

OAuth audience/resource identifier

grantTypestring required

OAuth grant type

enabledboolean required

Whether OAuth webhook authentication is enabled

Example response

{
  "clientId": "webhook-client-123",
  "tokenEndpointUrl": "https://auth.example.com/oauth/token",
  "scope": "webhooks:receive",
  "audience": "https://api.example.com",
  "grantType": "client_credentials",
  "enabled": true
}

Changes

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