Sign Customiser

Retrieve example webhook payloads for a specific topic. If data exists for the current organisation, real data will be used. Otherwise, example data is returned.

GET/api/v2/webhook-examples/{topic}

Authorisation

Bearer token required. Include it in theAuthorization header.

Path parameters

topicstringpathrequired

The webhook topic to get examples for. Must be one of: product:created, order:created, form:submitted.

Example: product:created

Webhook payload examples
curl https://web.signcustomiser.com/api/v2/webhook-examples/product%3Acreated \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "product": {
    "product_id": 1,
    "title": "Custom Neon: Hello World",
    "description": "Text: Hello World\nColour: Red\nFont: Comics",
    "description_html": "<p>Text: Hello World</p>\n<p>Colour: Red</p>\n<p>Font: Comics</p>",
    "external_id": "1234",
    "external_data": {},
    "price": 10000,
    "compare_price": 15000,
    "customiser_id": 1,
    "logo_upload_id": null,
    "product_image_url": "https://d1no4rdxmwcuog.cloudfront.net/default/app-images/demonstration_image_1.jpg",
    "uploads": [
      {
        "url": "https://d1no4rdxmwcuog.cloudfront.net/default/app-images/demonstration_image_1.jpg",
        "type": "product_image"
      }
    ],
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}