Myzone Webhooks API
The Webhooks API from Myzone — 2 operation(s) for webhooks.
The Webhooks API from Myzone — 2 operation(s) for webhooks.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/myzone:myzone-webhooks-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: external-api Webhooks API
description: The Myzone external API
version: 1.0.0
servers:
- url: https://ext-api.myzone.org
description: Live API
tags:
- name: Webhooks
paths:
/v1/webhooks:
post:
tags:
- Webhooks
summary: Register a webhook
description: '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.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookRegistration'
examples:
workoutCompleted:
summary: Subscribe to workout completions
value:
event: workout.completed
url: https://partner.example.com/hooks/myzone
headers:
x-api-key: your-shared-secret
required: true
responses:
'201':
description: Webhook created (or existing webhook returned).
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
example:
id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
event: workout.completed
url: https://partner.example.com/hooks/myzone
status: active
'401':
$ref: '#/components/responses/400Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
security:
- OAuth2:
- read:moves
operationId: postV1Webhooks
x-operation-id-source: derived
get:
tags:
- Webhooks
summary: List your webhooks
description: Returns only the webhook subscriptions owned by the calling client. Requires the `read:webhooks` scope.
responses:
'200':
description: The caller's webhook subscriptions.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Webhook'
example:
- id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
event: workout.completed
url: https://partner.example.com/hooks/myzone
status: active
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
security:
- OAuth2: []
operationId: getV1Webhooks
x-operation-id-source: derived
/v1/webhooks/{id}:
delete:
tags:
- Webhooks
summary: Delete a webhook
description: Delete a webhook subscription the calling client owns. Requires the `delete:webhooks` scope. Deleting an `id` that doesn't exist or that your client doesn't own returns `404`.
parameters:
- name: id
in: path
description: The opaque webhook id (a GUID) returned by create/list.
required: true
schema:
type: string
format: uuid
example: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
responses:
'204':
description: Webhook deleted. No content.
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
security:
- OAuth2: []
operationId: deleteV1WebhooksById
x-operation-id-source: derived
components:
schemas:
WebhookRegistration:
required:
- event
- url
type: object
properties:
event:
type: string
description: The event to subscribe to.
example: workout.completed
enum:
- workout.completed
url:
type: string
description: 'Your HTTPS destination. Must be a public host — `http://`, private/internal addresses, and non-public hostnames are rejected.
'
format: uri
example: https://partner.example.com/hooks/myzone
headers:
type:
- object
- 'null'
additionalProperties:
type: string
description: 'Optional extra HTTP headers sent with every delivery — use this to carry a secret your endpoint can check (e.g. an API key).
'
example:
x-api-key: your-shared-secret
description: Request body for registering a webhook.
Webhook:
required:
- event
- id
- status
- url
type: object
properties:
id:
type: string
description: 'Opaque webhook identifier (a GUID). Store it — you need it to delete the webhook.
'
format: uuid
example: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
event:
type: string
description: The event this webhook is subscribed to.
example: workout.completed
url:
type: string
description: The destination URL notifications are delivered to.
format: uri
example: https://partner.example.com/hooks/myzone
status:
type: string
description: 'Delivery status. `active` once delivery is live; `inhibited` if the webhook has been auto-disabled after sustained delivery failures (re-register the same event + url to re-activate).
'
example: active
enum:
- active
- inhibited
description: A webhook subscription.
responses:
401Error:
description: Unauthorized request
content:
application/json:
schema:
type: object
properties:
error:
type: string
403Error:
description: Forbidden request
content:
application/json:
schema:
type: object
properties:
error:
type: string
404Error:
description: Endpoint not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
400Error:
description: Invalid request
content:
application/json:
schema:
type: object
properties:
error:
type: string
securitySchemes:
OAuth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://auth.myzone.org/access_token
scopes:
read:accounts: client has read access to account api
write:accounts: client has write access to accounts api
read:moves: client has read access to moves api
read:biometrics: client has read access to biometrics api
write:biometrics: client has write access to biometrics api
read:classes_and_bookings: client has read access to classes and bookings api
write:classes_and_bookings: client has write access to classes and bookings api
delete:classes_and_bookings: client has delete access to classes and bookings api
read:challenges: client has read access to challenges api
read:facilities: client has read access to facilities api
read:reports: client has read access to reports api
read:groups: client has read access to groups api
write:groups: client has write access to groups api
delete:groups: client has delete access to groups api
read:moves:hr: client has read access to heart rate data
authorizationCode:
authorizationUrl: https://auth.myzone.org/authorize
tokenUrl: https://auth.myzone.org/access_token
scopes:
read:accounts: client has read access to account api
write:accounts: client has write access to accounts api
read:moves: client has read access to moves api
read:biometrics: client has read access to biometrics api
write:biometrics: client has write access to biometrics api
read:classes_and_bookings: client has read access to classes and bookings api
write:classes_and_bookings: client has write access to classes and bookings api
delete:classes_and_bookings: client has delete access to classes and bookings api
read:challenges: client has read access to challenges api
read:facilities: client has read access to facilities api
read:reports: client has read access to reports api
read:groups: client has read access to groups api
write:groups: client has write access to groups api
delete:groups: client has delete access to groups api
x-provenance:
method: searched
source: https://docs.myzone.org/reference
harvested: '2026-11-16'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.myzone.org/reference/delete_v1-accounts-accountid-devices-deviceid.md
- https://docs.myzone.org/reference/delete_v1-classes-occurrences-bookings-bookingid.md
- https://docs.myzone.org/reference/delete_v1-facilities-facilityid-groups-groupid.md
- https://docs.myzone.org/reference/delete_v1-webhooks-id.md
- https://docs.myzone.org/reference/get_v1-accounts-accountid-biometrics.md
- https://docs.myzone.org/reference/get_v1-accounts-accountid-devices.md
- https://docs.myzone.org/reference/get_v1-accounts-accountid-stats.md
- https://docs.myzone.org/reference/get_v1-biometrics.md
- https://docs.myzone.org/reference/get_v1-challenges-challengeid-leaderboard.md
- https://docs.myzone.org/reference/get_v1-challenges.md
- https://docs.myzone.org/reference/get_v1-classes-shared.md
- https://docs.myzone.org/reference/get_v1-facilities-facilityid-groups.md
- https://docs.myzone.org/reference/get_v1-facilities-facilityid-reports-report.md
- https://docs.myzone.org/reference/get_v1-facilities.md
- https://docs.myzone.org/reference/get_v1-groups-accounts.md
- https://docs.myzone.org/reference/get_v1-moves-accountid-moveid.md
- https://docs.myzone.org/reference/get_v1-moves-moveid-reports-report.md
- https://docs.myzone.org/reference/get_v1-webhooks.md
- https://docs.myzone.org/reference/getv1accounts.md
- https://docs.myzone.org/reference/getv1accountsaccountid.md
- https://docs.myzone.org/reference/getv1classes.md
- https://docs.myzone.org/reference/getv1classesclassid.md
- https://docs.myzone.org/reference/getv1classesclassidoccurrences.md
- https://docs.myzone.org/reference/getv1classesoccurrencesoccurrenceid.md
- https://docs.myzone.org/reference/getv1classesoccurrencesoccurrenceidbookings.md
- https://docs.myzone.org/reference/getv1classtemplates.md
- https://docs.myzone.org/reference/getv1movesaccountid.md
- https://docs.myzone.org/reference/patch_v1-classes-classid-delete.md
- https://docs.myzone.org/reference/patch_v1-classes-occurrences-bookings-bookingid-delete.md
- https://docs.myzone.org/reference/patch_v1-facilities-facilityid-groups-groupid-users.md
- https://docs.myzone.org/reference/patch_v1-facilities-facilityid-removeaccounts.md
- https://docs.myzone.org/reference/post_v1-accounts-accountid-devices.md
- https://docs.myzone.org/reference/post_v1-groups.md
- https://docs.myzone.org/reference/post_v1-webhooks.md
- https://docs.myzone.org/reference/postv1accounts.md
- https://docs.myzone.org/reference/postv1classes.md
- https://docs.myzone.org/reference/postv1classesoccurrencesoccurrenceidbookings.md
- https://docs.myzone.org/reference/put_v1-accounts-accountid-biometrics.md
- https://docs.myzone.org/reference/putv1accountsaccountid.md
- https://docs.myzone.org/reference/putv1classesclassid.md
- https://docs.myzone.org/reference/putv1classesoccurrencesoccurrenceid.md
merge:
pages: 41
deduped: 224
conflicts_kept_first: 0