Skip to content
/Webhook Management

Cheqi API (v1)

Cheqi provides APIs for creating receipts and reading receipts for customers

Download OpenAPI description
api-docs.json
api-docs.yaml
Languages
Servers
Mock server
https://docs.cheqi.io/_mock/apis/api-docs
Generated server url
https://test.api.cheqi.io

Client Application Management

Endpoints for managing OAuth2 client applications, including registration, secret management, and public key configuration

Operations

Credit Note Management

Endpoints for creating, managing, and retrieving credit notes (refund receipts)

Operations

Recipient Management

Endpoints for resolving and matching receipt recipients

Operations

Receipt Management

Endpoints for creating and managing purchase receipts with end-to-end encryption

Operations

Webhook Management

Endpoints for managing webhook subscriptions to receive real-time event notifications

Operations

Create webhook subscription

Request

Creates a webhook subscription to receive real-time notifications for receipt and credit note events. The webhook URL will be called when events occur for the authenticated company or client application.

Accessible for: Company, Client Application

Security
cheqi_oauth
Bodyapplication/jsonrequired
namestring
eventsArray of strings
Items Enum"RECEIPT_CREATED""RECEIPT_FINALIZED""RETURN_REQUESTED""CREDIT_NOTE_CREATED"
receiptFormatstring
Enum"JSON""XML"
notificationUrlstring
curl -i -X POST \
  https://docs.cheqi.io/_mock/apis/api-docs/webhook/subscription \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "events": [
      "RECEIPT_CREATED"
    ],
    "receiptFormat": "JSON",
    "notificationUrl": "string"
  }'

Responses

Webhook subscription created successfully

Bodyapplication/json
createdWebhooksArray of objects(WebhookDTO)
failedEventsArray of strings
Response
application/json
{
  "createdWebhooks": [
    { … }
  ],
  "failedEvents": [
    "string"
  ]
}