{ "openapi": "3.0.0", "info": { "title": "GymFlexa API", "version": "1.0.0" }, "servers": [ { "url": "https://api.gymflexa.com" } ], "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "basic", "description": "HTTP Basic auth carrying only the API key secret: Authorization: Basic base64()." }, "accessToken": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Operator session token issued by the GymFlexa dashboard: Authorization: Token ." } }, "schemas": { "Error": { "type": "object", "required": [ "message", "status" ], "properties": { "message": { "type": "string" }, "status": { "type": "integer" }, "name": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "Appointment": { "type": "object", "required": [ "_id" ], "properties": { "_id": { "type": "string" }, "gymId": { "type": "string" }, "memberId": { "type": "string" }, "serviceId": { "type": "string" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "notes": { "type": "string" }, "creationTime": { "type": "string", "format": "date-time", "readOnly": true }, "lastEditTime": { "type": "string", "format": "date-time" } }, "additionalProperties": true }, "Gym": { "type": "object", "required": [ "_id" ], "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "address": { "type": "string" }, "countryCode": { "type": "string" }, "appointmentDuration": { "type": "integer", "minimum": 1 }, "openingHours": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "creationTime": { "type": "string", "format": "date-time", "readOnly": true }, "lastEditTime": { "type": "string", "format": "date-time" } }, "additionalProperties": true }, "Member": { "type": "object", "required": [ "_id" ], "properties": { "_id": { "type": "string" }, "gymId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date" }, "creationTime": { "type": "string", "format": "date-time", "readOnly": true }, "lastEditTime": { "type": "string", "format": "date-time" } }, "additionalProperties": true }, "Payment": { "type": "object", "required": [ "_id" ], "properties": { "_id": { "type": "string" }, "gymId": { "type": "string" }, "memberId": { "type": "string" }, "amount": { "type": "number" }, "currency": { "type": "string" }, "date": { "type": "string", "format": "date" }, "reference": { "type": "string" }, "creationTime": { "type": "string", "format": "date-time", "readOnly": true }, "lastEditTime": { "type": "string", "format": "date-time" } }, "additionalProperties": true }, "Service": { "type": "object", "required": [ "_id" ], "properties": { "_id": { "type": "string" }, "gymId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "duration": { "type": "integer", "minimum": 1 }, "price": { "type": "number" }, "color": { "type": "string" }, "creationTime": { "type": "string", "format": "date-time", "readOnly": true }, "lastEditTime": { "type": "string", "format": "date-time" } }, "additionalProperties": true }, "WebhookSubscription": { "type": "object", "required": [ "_id" ], "properties": { "_id": { "type": "string" }, "gymId": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "consecutiveFailures": { "type": "integer", "minimum": 0 }, "creationTime": { "type": "string", "format": "date-time", "readOnly": true }, "lastEditTime": { "type": "string", "format": "date-time" } }, "additionalProperties": true }, "WebhookSubscriptionWithSecret": { "allOf": [ { "$ref": "#/components/schemas/WebhookSubscription" }, { "type": "object", "required": [ "secret" ], "properties": { "secret": { "type": "string", "readOnly": true, "description": "Signing secret returned exactly once on creation." } } } ] }, "DeletedResource": { "type": "object", "required": [ "_id" ], "properties": { "_id": { "type": "string" } }, "additionalProperties": false } } }, "paths": { "/api/appointments": { "get": { "tags": [ "Appointments" ], "summary": "List appointments", "description": "Lists the appointments of your gym. Requires the `appointments:read` scope.\n", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "query", "name": "gymId", "schema": { "type": "string" } }, { "in": "query", "name": "memberId", "schema": { "type": "string" } }, { "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Comma-separated projection of fields to return", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Array of appointments", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Appointment" } } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API key is missing the `appointments:read` scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API key rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiAppointments" }, "post": { "tags": [ "Appointments" ], "summary": "Create an appointment", "description": "Requires the `appointments:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "The created appointment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointment" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postApiAppointments" } }, "/api/appointments/{appointmentId}": { "get": { "tags": [ "Appointments" ], "summary": "Get an appointment", "description": "Returns a single appointment by id. Appointments belonging to another organization respond 404. Requires the `appointments:read` scope.\n", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "appointmentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The appointment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointment" } } } }, "404": { "description": "Not found (or owned by another organization)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiAppointmentsAppointmentId" }, "put": { "tags": [ "Appointments" ], "summary": "Update an appointment", "description": "Requires the `appointments:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "appointmentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The updated appointment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointment" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putApiAppointmentsAppointmentId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointment" } } } } } }, "/api/gyms": { "get": { "tags": [ "Gyms" ], "summary": "List gyms", "description": "Lists the gyms of your organization. Requires the `gyms:read` scope.\n", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "responses": { "200": { "description": "Array of gyms", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Gym" } } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API key is missing the `gyms:read` scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API key rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiGyms" }, "post": { "tags": [ "Gyms" ], "summary": "Create a gym", "description": "Requires the `gyms:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "The created gym", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gym" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postApiGyms" } }, "/api/gyms/{gymId}": { "get": { "tags": [ "Gyms" ], "summary": "Get a gym", "description": "Returns a single gym by id. Readable anonymously — the public whitelabel site resolves a gym without a vanity name by this id. Gyms belonging to another organization respond 404 to an authenticated caller. An API key must carry the `gyms:read` scope.\n", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "gymId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The gym", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gym" } } } }, "404": { "description": "Not found (or owned by another organization)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiGymsGymId" }, "put": { "tags": [ "Gyms" ], "summary": "Update a gym", "description": "Requires the `gyms:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "gymId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The updated gym", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gym" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putApiGymsGymId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gym" } } } } }, "delete": { "tags": [ "Gyms" ], "summary": "Delete a gym", "description": "Requires the `gyms:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "gymId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The deleted gym", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedResource" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteApiGymsGymId" } }, "/api/members": { "get": { "tags": [ "Members" ], "summary": "List members", "description": "Lists the members of your gym. Requires the `members:read` scope.\n", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "query", "name": "gymId", "schema": { "type": "string" } }, { "in": "query", "name": "email", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Comma-separated projection of fields to return", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Array of members", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API key is missing the `members:read` scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API key rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiMembers" }, "post": { "tags": [ "Members" ], "summary": "Create a member", "description": "Requires the `members:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "The created member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postApiMembers" } }, "/api/members/{memberId}": { "get": { "tags": [ "Members" ], "summary": "Get a member", "description": "Returns a single member by id. Members belonging to another organization respond 404. Requires the `members:read` scope.\n", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "memberId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } } }, "404": { "description": "Not found (or owned by another organization)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiMembersMemberId" }, "put": { "tags": [ "Members" ], "summary": "Update a member", "description": "Requires the `members:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "memberId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The updated member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putApiMembersMemberId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } } } }, "delete": { "tags": [ "Members" ], "summary": "Delete a member", "description": "Requires the `members:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "memberId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The deleted member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedResource" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteApiMembersMemberId" } }, "/api/payments": { "get": { "tags": [ "Payments" ], "summary": "List payments", "description": "Lists the payments of your gym. Requires the `payments:read` scope.\n", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "query", "name": "gymId", "schema": { "type": "string" } }, { "in": "query", "name": "memberId", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Comma-separated projection of fields to return", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Array of payments", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API key is missing the `payments:read` scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API key rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiPayments" }, "post": { "tags": [ "Payments" ], "summary": "Create a payment", "description": "Requires the `payments:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "The created payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postApiPayments" } }, "/api/payments/{paymentId}": { "get": { "tags": [ "Payments" ], "summary": "Get a payment", "description": "Returns a single payment by id. Payments belonging to another organization respond 404. Requires the `payments:read` scope.\n", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "paymentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } }, "404": { "description": "Not found (or owned by another organization)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiPaymentsPaymentId" }, "put": { "tags": [ "Payments" ], "summary": "Update a payment", "description": "Requires the `payments:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "paymentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The updated payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putApiPaymentsPaymentId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } } }, "delete": { "tags": [ "Payments" ], "summary": "Delete a payment", "description": "Requires the `payments:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "paymentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The deleted payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedResource" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteApiPaymentsPaymentId" } }, "/api/services": { "get": { "tags": [ "Services" ], "summary": "List services", "description": "Lists the services offered by your gym. Requires the `services:read` scope.\n", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "query", "name": "gymId", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Comma-separated projection of fields to return", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Array of services", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Service" } } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API key is missing the `services:read` scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API key rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiServices" }, "post": { "tags": [ "Services" ], "summary": "Create a service", "description": "Requires the `services:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "The created service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postApiServices" } }, "/api/services/{serviceId}": { "get": { "tags": [ "Services" ], "summary": "Get a service", "description": "Returns a single service by id. Services belonging to another organization respond 404. Requires the `services:read` scope.\n", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "serviceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" } } } }, "404": { "description": "Not found (or owned by another organization)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiServicesServiceId" }, "put": { "tags": [ "Services" ], "summary": "Update a service", "description": "Requires the `services:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "serviceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The updated service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putApiServicesServiceId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" } } } } }, "delete": { "tags": [ "Services" ], "summary": "Delete a service", "description": "Requires the `services:write` scope.", "security": [ { "apiKey": [] }, { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "serviceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The deleted service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedResource" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteApiServicesServiceId" } }, "/api/webhooksubscriptions": { "get": { "tags": [ "Webhook subscriptions" ], "summary": "List webhook subscriptions", "description": "Webhook subscriptions deliver member, appointment and payment lifecycle events to your server as signed POST requests (`X-Gymflexa-Signature: t=,v1=`). An endpoint failing 20 times in a row is disabled automatically. Subscriptions are managed with an operator access token; the `secret` is only returned once, on create.\n", "security": [ { "accessToken": [] } ], "responses": { "200": { "description": "Array of webhook subscriptions (without secrets)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookSubscription" } } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getApiWebhooksubscriptions" }, "post": { "tags": [ "Webhook subscriptions" ], "summary": "Create a webhook subscription", "description": "The response includes the signing `secret` exactly once — store it; it cannot be retrieved again.\n", "security": [ { "accessToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "gymId", "url" ], "properties": { "gymId": { "type": "string" }, "url": { "type": "string", "example": "https://example.com/gymflexa-webhook" }, "events": { "type": "array", "description": "Empty array subscribes to all events", "items": { "type": "string", "enum": [ "member.created", "member.updated", "member.deleted", "appointment.created", "appointment.updated", "appointment.deleted", "payment.created" ] } } } } } } }, "responses": { "200": { "description": "The created subscription, including its secret", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionWithSecret" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "postApiWebhooksubscriptions" } }, "/api/webhooksubscriptions/{webhookSubscriptionId}": { "put": { "tags": [ "Webhook subscriptions" ], "summary": "Update a webhook subscription", "description": "`url`, `events` and `active` are editable; the secret and gym are immutable. Re-enabling an auto-disabled endpoint is done by setting `active` back to true.\n", "security": [ { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "webhookSubscriptionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "The updated subscription (without secret)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscription" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "putApiWebhooksubscriptionsWebhookSubscriptionId" }, "delete": { "tags": [ "Webhook subscriptions" ], "summary": "Delete a webhook subscription", "security": [ { "accessToken": [] } ], "parameters": [ { "in": "path", "name": "webhookSubscriptionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedResource" } } } }, "default": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "deleteApiWebhooksubscriptionsWebhookSubscriptionId", "description": "Delete a webhook subscription" } } }, "tags": [] }