webhooks

Returns the webhook configuration details

Returns the webhook configuration details for the current owner of the webhooks

get/v0/api_webhooks/{id}

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v0/api_webhooks/{id}
  • Auth: OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)

Path parameters

idstring required

Headers

authorizationstring required

Optional Access Token (bearer)

Example:Bearer aaaa.vbbbB.bbbb

Access Token (bearer)

x-api-keystring required

Api_key provided by ClubMed API team

Response

ok

urlstring required

The Payload url called to send Clubmed webhook events

content_type'application/json' | 'application/x-www-form-urlencoded' required

The content-type used to call the Payload URL

headersHeaders

The headers used to call the Payload URL

secretstring required

The secret key shared between the consumer and the API

ownerstring

Api_key provided by ClubMed API team

eventsApiWebhookAllowedEventModel[]

Deprecated: legacy subscribed event names. Use subscriptions[] instead.

idstring required

The webhook configuration ID

Example response

{
  "url": "https://app.clubmed.com/callback",
  "content_type": "application/json",
  "secret": "mysecretkey",
  "events": [
    "ping"
  ],
  "subscriptions": [
    {
      "event": "ping"
    }
  ],
  "id": "48404de3-9451-4c6c-8908-7dfe32cfbeb3"
}

Changes

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