Register a webhook (Draft)

Register a webhook subscription. Requires the write:webhooks scope and the event's data scope (read:moves for workout.completed).

Idempotent: registering the same event + url again returns the existing webhook rather than creating a duplicate, and re-activates it if it had been disabled.

Required Scope: write:webhooks

And the scope associated with the event you are subscribing to:

  • workout.completed: read:moves

Body Params

Request body for registering a webhook.

string
enum
required

The event to subscribe to.

Allowed:
uri
required

Your HTTPS destination. Must be a public host — http://, private/internal addresses, and non-public hostnames are rejected.

headers
object | null

Optional extra HTTP headers sent with every delivery — use this to carry a secret your endpoint can check (e.g. an API key).

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json