openapi: 3.2.0 info: title: Dojo Webhooks API version: '2026-02-27' description: "# Introduction\n\nThe Dojo API is a REST API, using HTTP response codes to convey status, including successful responses and errors. Additionally, it accepts and returns JSON in the HTTP body.\nFor information on the latest development progress, visit the [changelog](../changelog).\n\n## Base URLs\n\nUse the following base URL when making requests to the API: https://api.dojo.tech/\n\n## Authentication\n\nThe Dojo API uses [Basic HTTP authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). You can generate API keys in the [Developer Portal](https://developer.dojo.tech).\nSecret keys for the test environment use the prefix `sk_sandbox_`. Production keys use the prefix `sk_prod_`.\n\nYou must include your secret API key in the header of all requests, for example:\n\n```curl\n --header 'content-type: application/json' \\\n --header 'Authorization: Basic sk_prod_your_key' \\\n```\n\nAPI requests without authentication will fail.\n\n## Additional Required Headers\n\nThe following headers are required on Terminal and Terminal Sessions API requests, requests without them will fail.\n\n- `reseller-id` - Identifies the reseller who sells software on behalf of the EPOS company. This value will be unique and provided by Dojo to each reseller.\n- `software-house-id` - Identifies the EPOS company whose software is generating the request. This value shouldn't be configurable, as it will remain the same for all customers using particular EPOS software. This value will be provided by Dojo.\n\n## HTTP Responses\n\nThe API returns standard HTTP response codes [RFC 7231](https://tools.ietf.org/html/rfc7231#section-6) on each request to indicate the success or otherwise of API requests. Summaries for each HTTP code are listed below:\n\n* `200 OK`—The request was successful.\n\n* `201 Created`—The request was successful, and a new resource was created as a result.\n\n* `204 No Content`—The request was successful, but there is no content to send.\n\n* `400 Bad Request`—Bad request, probably due to a syntax error.\n\n* `401 Unauthorized`—Authentication required.\n\n* `403 Forbidden`—The API key doesn't have permissions.\n\n* `404 Not Found`—The resource doesn't exist.\n\n* `405 Method Not Allowed`—The request method is known by the server but isn't supported by the target resource.\n\n* `409 Conflict`—The request couldn't be completed because it conflicted with another request or the server's configuration.\n\n* `500`, `502`, `503`, `504` `Server Errors`—An error occurred with our API.\n\n## Errors\n\nDojo follows the error response format proposed in [RFC 7807](https://tools.ietf.org/html/rfc7807), also known as Problem Details for HTTP APIs. All errors are returned in the form of JSON.\n\n### Error Schema\n\nIn case of an error, the response object contains the following fields:\n\n* `errors` [object]—A human-readable explanation of errors.\n\n* `type` [string]—\nA URI reference RFC 3986 that identifies the problem type.\n\n* `title` [string]—A short, human-readable summary of the error.\n\n* `status` [integer]—The HTTP status code.\n\n* `detail` [string]—A human-readable message giving more details about the error. Not always present.\n\n* `traceId` [string]—The unique identifier of the failing request.\n\nThe following example shows a possible error response:\n\n```json\n{\n \"errors\": {\n \"Reference\": [\n \"The Reference field is required.\"\n ]\n },\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"traceId\": \"00-a405f077df056a498323ffbcec05923f-aa63e6f4dbbc734a-01\",\n}\n```\n\n## Versioning\n\nDojo APIs use the yyyy-mm-dd API version-naming scheme. You have to pass the version as the `version` header in all API calls, for example:\n\n``` curl\n --header 'content-type: application/json' \\\n --header 'Authorization: Basic sk_prod_your_key' \\\n --header 'version: 2026-02-27' \\\n```\n\nWhen we make [breaking changes](../development-resources/versioning-overview#breaking-changes) to the API, we release new dated versions.\n\nThe current version is `2026-02-27`.\n\n## SDKs\nUse our PHP, .NET, and mobile [client libraries](/development-resources/sdk) to build your integration.\n\n## Code Samples\n\nGet help in building your integration with our [code samples](/development-resources/code-samples).\n" termsOfService: https://dojo.tech/legal/ contact: name: Dojo Developer Experience Team servers: - url: https://api.dojo.tech security: - ApiKeyAuth: [] tags: - name: Webhooks description: 'Webhooks notify you when a specific event has occurred. **Documentation**: [Webhooks](../../development-resources/webhooks)' paths: /webhooks/events: get: tags: - Webhooks operationId: Webhooks_GetAllWebhooks summary: List all events description: Retrieves a list of all events. parameters: - $ref: '#/components/parameters/Version' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/WebhookEvents' example: - model: PaymentIntent events: - payment_intent.created - payment_intent.updated - model: Payment events: - payment.successful - model: Order events: - order.created '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /webhooks: get: tags: - Webhooks operationId: Webhooks_GetAlSubscriptions summary: List all subscriptions description: Retrieves a list of all subscriptions. parameters: - $ref: '#/components/parameters/Version' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Subscription' example: id: ws_aNkU6yob0vOMxUlghg2oynUw accountId: acc_4z3k2xP17e1JQY events: - payment_intent.created - payment_intent.status_updated url: https://example.com.com/incoming-events description: Demo Webhooks secrets: - id: sc_qNkU6yob0vOMxUlb2oynUw value: U3Vic2NyaXB0aW9uUmVzcG9uc2VFeGFtcGxlIDogSUV4YW1wbGVQcm92aWRlcjxTdWJ createdAt: '2023-12-13T14:15:01' lastUsedAt: '2023-12-16T13:44:03.3242202Z' isActive: true createdAt: '2023-03-30T12:21:04.143Z' updatedAt: '2023-03-30T12:21:04.143Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' post: tags: - Webhooks operationId: Webhooks_Subscribe summary: Subscribe to an event description: Creates a new subscription. parameters: - $ref: '#/components/parameters/Version' requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/SubscriptionRequest' required: true x-position: 1 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Subscription' example: id: ws_aNkU6yob0vOMxUlghg2oynUw accountId: acc_4z3k2xP17e1JQY events: - payment_intent.created - payment_intent.status_updated url: https://example.com.com/incoming-events description: Demo Webhooks secrets: - id: sc_qNkU6yob0vOMxUlb2oynUw value: U3Vic2NyaXB0aW9uUmVzcG9uc2VFeGFtcGxlIDogSUV4YW1wbGVQcm92aWRlcjxTdWJ createdAt: '2023-12-13T14:15:01' lastUsedAt: '2023-12-16T13:44:03.3242202Z' isActive: true createdAt: '2023-03-30T12:21:04.143Z' updatedAt: '2023-03-30T12:21:04.143Z' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /webhooks/{subscriptionId}/secrets: get: tags: - Webhooks operationId: Webhooks_GetSecrets summary: List all secrets description: Retrieves a list of all secrets. parameters: - $ref: '#/components/parameters/Version' - name: subscriptionId in: path required: true schema: type: string x-position: 1 description: The unique identifier for the subscription. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SecretsResponse' example: id: ws_lgQzejyXb0SD8oIDE2zcqA secrets: - id: sc_qNkU6yob0vOMxUlb2oynUw value: U3Vic2NyaXB0aW9uUmVzcG9uc2VFeGFtcGxlIDogSUV4YW1wbGVQcm92aWRlcjxTdWJ createdAt: '2023-12-13T14:15:01' lastUsedAt: '2023-12-16T13:44:03.3656144Z' isActive: true - id: sc_zNkU6yob0vOMxUlb2oynUw value: FGswesdsaXB0aW9uUmVzcG9wbGVQcm92aWRlcjxTdWJ createdAt: '2020-12-13T14:15:01' lastUsedAt: '2023-12-02T13:58:03.3656159Z' isActive: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' post: tags: - Webhooks operationId: Webhooks_GenerateSecret summary: Generate a secret description: Generates a new secret. parameters: - $ref: '#/components/parameters/Version' - name: subscriptionId in: path required: true schema: type: string x-position: 1 description: The unique identifier for the subscription. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SecretsResponse' example: secrets: - id: sc_qNkU6yob0vOMxUlb2oynUw value: U3Vic2NyaXB0aW9uUmVzcG9uc2VFeGFtcGxlIDogSUV4YW1wbGVQcm92aWRlcjxTdWJ createdAt: '2023-12-13T14:15:01' lastUsedAt: '2023-12-16T13:44:03.3683851Z' isActive: true - id: sc_zNkU6yob0vOMxUlb2oynUw value: FGswesdsaXB0aW9uUmVzcG9wbGVQcm92aWRlcjxTdWJ createdAt: '2023-12-13T14:15:01' lastUsedAt: '2023-12-02T13:58:03.3683861Z' isActive: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /webhooks/{subscriptionId}/secrets/{secretId}/activate: put: tags: - Webhooks operationId: Webhooks_ActivateSecret summary: Activate a secret description: Activates a secret. parameters: - $ref: '#/components/parameters/Version' - name: subscriptionId in: path required: true schema: type: string x-position: 1 description: The unique identifier for the subscription. - name: secretId in: path required: true schema: type: string x-position: 2 description: The unique identifier for the secret. responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /webhooks/{subscriptionId}/secrets/{secretId}: delete: tags: - Webhooks operationId: Webhooks_DeleteSecret summary: Delete a secret description: Deletes a secret. parameters: - $ref: '#/components/parameters/Version' - name: subscriptionId in: path required: true schema: type: string x-position: 1 description: The unique identifier for the subscription. - name: secretId in: path required: true schema: type: string x-position: 2 description: The unique identifier for the secret. responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /webhooks/{subscriptionId}: patch: tags: - Webhooks operationId: Webhooks_SubscribeUpdate summary: Update a subscription description: Updates your subscription details. You can change the URL or the list of events. parameters: - $ref: '#/components/parameters/Version' - name: subscriptionId in: path required: true schema: type: string x-position: 1 description: The unique identifier for the subscription. requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/SubscriptionUpdateRequest' required: true x-position: 1 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Subscription' example: id: ws_aNkU6yob0vOMxUlghg2oynUw accountId: acc_4z3k2xP17e1JQY events: - payment_intent.created - payment_intent.status_updated url: https://example.com.com/incoming-events description: Demo Webhooks secrets: - id: sc_qNkU6yob0vOMxUlb2oynUw value: U3Vic2NyaXB0aW9uUmVzcG9uc2VFeGFtcGxlIDogSUV4YW1wbGVQcm92aWRlcjxTdWJ createdAt: '2023-12-13T14:15:01' lastUsedAt: '2023-12-16T13:44:03.3242202Z' isActive: true createdAt: '2023-03-30T12:21:04.143Z' updatedAt: '2023-03-30T12:21:04.143Z' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' delete: tags: - Webhooks operationId: Webhooks_DeleteSubscriptions summary: Delete a subscription description: Deletes a subscription. parameters: - name: subscriptionId in: path required: true schema: type: string x-position: 1 description: The unique identifier for the subscription. - $ref: '#/components/parameters/Version' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: Subscription: type: object additionalProperties: false properties: id: type: string description: The unique identifier for the subscription. accountId: type: - string - 'null' description: The unique identifier for the account. events: type: array description: The list of events. items: type: string url: type: string description: The URL of the Webhook endpoint. format: uri minLength: 1 pattern: ^https://*.+ description: type: - string - 'null' description: The subscription description. secrets: type: array description: The list of secrets associated with the subscription. Used to generate signatures. items: $ref: '#/components/schemas/SubscriptionSecret' createdAt: type: string format: date-time description: 'The creation date, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format. ' updatedAt: type: string format: date-time description: The timestamp of the update date, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format. SecretsResponse: type: object additionalProperties: false properties: id: type: string description: The unique identifier for the subscription. secrets: type: array description: The list of secrets associated with the subscription. Used to generate signatures. items: $ref: '#/components/schemas/SubscriptionSecret' SubscriptionSecret: type: object additionalProperties: false properties: id: type: string description: The unique identifier for the secret. value: type: string description: The secret value. createdAt: type: string format: date-time description: The timestamp of the created date, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format. isActive: type: boolean description: The status of the secret. It can be activated or deactivated. SubscriptionUpdateRequest: type: object example: events: - payment_intent.created - order.created additionalProperties: false properties: events: type: - array - 'null' description: The list of events. items: type: string url: type: - string - 'null' description: The URL of the Webhook endpoint. format: uri pattern: ^https://*.+ description: type: - string - 'null' description: The subscription description. WebhookEvents: type: object additionalProperties: false properties: model: type: string description: The Webhook type. events: type: array description: The list of events. items: type: string ErrorResponse: type: object additionalProperties: false properties: errors: type: - object - 'null' additionalProperties: type: array items: type: string type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 traceId: type: - string - 'null' detail: type: - string - 'null' SubscriptionRequest: type: object example: events: - payment_intent.created - payment.successful - order.created url: https://example.com/incoming-events additionalProperties: false required: - events - url properties: events: type: array description: The list of events. items: type: string url: type: string format: uri minLength: 1 pattern: ^https://*.+ description: The URL of the Webhook endpoint. description: type: - string - 'null' description: The subscription description. parameters: Version: name: version in: header required: true schema: type: string format: date example: '2026-02-27' description: The API version with format yyyy-mm-dd. The current version is `2026-02-27`. securitySchemes: ApiKeyAuth: type: apiKey name: Authorization in: header x-tagGroups: - name: Core payments tags: - Payment intents - Refunds - Reversal - Captures - Webhooks - Customers - Setup intents - name: In-person payments tags: - Terminals - Terminal sessions - name: Capabilities tags: - Capabilities - Events