# API Reference

Use the Sign Customiser API to build custom integrations, submit completed orders, manage webhook subscriptions, and inspect signed delivery payloads.

- Source URL: https://www.signcustomiser.com/help/api/
- Markdown URL: https://www.signcustomiser.com/help/api/index.md
- Base URL: https://web.signcustomiser.com
- Auth: Bearer token

## Custom integration flow

- [Product created](https://www.signcustomiser.com/help/api/webhook-product-created/): Receive the signed product creation callback, create the product in your own platform, and return the external ID that Sign Customiser should store.
- [Create an order](https://www.signcustomiser.com/help/api/post-create-an-order/): Submit the completed order from your own platform after checkout finishes and match each external product ID to the earlier callback response.
- [Create a new webhook](https://www.signcustomiser.com/help/api/post-create-a-new-webhook/): Register outbound webhook subscriptions if you also need event notifications in your own systems.

## Machine-readable resources

- [openapi.yaml](https://www.signcustomiser.com/help/openapi.yaml): Machine-readable OpenAPI schema for the public API.
- [openapi.json](https://www.signcustomiser.com/help/openapi.json): JSON version of the OpenAPI schema for the public API.
- [collection.json](https://www.signcustomiser.com/help/collection.json): Postman collection generated from the Scribe API reference.
- [skill.md](https://www.signcustomiser.com/help/skill.md): Agent-friendly Sign Customiser documentation skill file.
- [llms.txt](https://www.signcustomiser.com/help/llms.txt): Compact public index of help articles, API pages, and machine-readable resources.
- [llms-full.txt](https://www.signcustomiser.com/help/llms-full.txt): Full-text corpus of help articles and API documentation for language models.

## Endpoint groups

### Custom integrations

Backend contract for custom integrations: handle the signed product creation callback, return your own product ID, then submit completed orders into Sign Customiser.

- [POST Create an order](https://www.signcustomiser.com/help/api/post-create-an-order/): Step 2 of the custom integration flow. After your server handles the `product:created` callback and returns an `external_id`, send the completed order from your ecommerce platform. Each `products[].external_id` value must match a product ID you previously returned during product creation.
- [POST Create a legacy order](https://www.signcustomiser.com/help/api/post-create-a-legacy-order/): Deprecated. Use `POST /api/v2/orders` for new integrations.
- [POST Sync a legacy product](https://www.signcustomiser.com/help/api/post-sync-a-legacy-product/): Deprecated. Use the current custom integration flow for new builds.

### Customisers

- [GET List customisers](https://www.signcustomiser.com/help/api/get-list-customisers/): Get all customisers for the current organisation.
- [GET Get a customiser](https://www.signcustomiser.com/help/api/get-get-a-customiser/): Retrieve a single customiser.

### Pricing

- [GET Get customiser pricing](https://www.signcustomiser.com/help/api/get-get-customiser-pricing/): Retrieve all pricing configuration for a customiser.
- [PUT Update customiser pricing](https://www.signcustomiser.com/help/api/put-update-customiser-pricing/): Replace all pricing configuration for a customiser.

### Webhook events

Signed delivery payloads sent from Sign Customiser to your own application, including the product creation callback used by custom integrations.

- [WEBHOOK Product created](https://www.signcustomiser.com/help/api/webhook-product-created/): Use this as the product creation callback for custom integrations. When a customer finishes a design, Sign Customiser POSTs this payload to the create-product URL configured on your custom integration. Verify the signature, create the product in your own platform, then return a 200 JSON response containing the `external_id` you will later send in `POST /api/v2/orders`.
- [WEBHOOK Order created](https://www.signcustomiser.com/help/api/webhook-order-created/): Delivered when Sign Customiser records a completed order for your organisation.
- [WEBHOOK Form submitted](https://www.signcustomiser.com/help/api/webhook-form-submitted/): Delivered when a customer submits a Sign Customiser form workflow.

### Webhooks

Manage webhook subscriptions and inspect the event topics Sign Customiser can deliver to your own systems.

- [GET List all webhooks](https://www.signcustomiser.com/help/api/get-list-all-webhooks/): Get a list of all webhooks for the current organisation.
- [POST Create a new webhook](https://www.signcustomiser.com/help/api/post-create-a-new-webhook/): Register a new webhook endpoint to receive event notifications.
- [GET Get a single webhook](https://www.signcustomiser.com/help/api/get-get-a-single-webhook/): Retrieve details for a specific webhook.
- [PUT Update a webhook](https://www.signcustomiser.com/help/api/put-update-a-webhook/): Update an existing webhook's topic, URL, or metadata.
- [DELETE Delete a webhook](https://www.signcustomiser.com/help/api/delete-delete-a-webhook/): Remove a webhook subscription.