# GET Webhook payload examples

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.

- Source URL: https://www.signcustomiser.com/help/api/get-webhook-payload-examples/
- Markdown URL: https://www.signcustomiser.com/help/api/get-webhook-payload-examples.md
- Group: Webhooks
- Method: GET
- Path: /api/v2/webhook-examples/{topic}
- Auth: Bearer token

## Deprecated operation

Deprecated on 22 July 2026. Sunset is scheduled for 22 January 2027; route removal still requires separate approval.

[Follow the v2 to v3 migration guide](https://www.signcustomiser.com/help/api/guides/migration-v2-to-v3/).

## Path parameters

- topic (string, required): The webhook topic to get examples for. Must be one of: product:created, order:created, form:submitted. Example: product:created

## cURL example

```bash
curl https://web.signcustomiser.com/api/v2/webhook-examples/product%3Acreated \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
```

## Response examples

### 200 Product Created

```json
{
  "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"
  }
}
```

### 200 Order Created

```json
{
  "order": {
    "order_id": 1,
    "order_number": 4,
    "external_order_number": "SIGN-12345",
    "external_id": "12345",
    "order_total": 120000,
    "app_total": 100000,
    "currency": "USD",
    "shipping_line": "ground",
    "billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "company": "Acme",
      "address_1": "123 Fake Street",
      "address_2": "Unit 456",
      "city": "Brisbane",
      "state": "Queensland",
      "postcode": "4000",
      "country": "Australia",
      "phone": "123456789",
      "email": "john@example.com",
      "created_at": "2025-10-22T00:55:09+00:00",
      "updated_at": "2025-10-22T00:55:09+00:00"
    },
    "shipping_address": {
      "first_name": "John",
      "last_name": "Doe",
      "company": "Acme",
      "address_1": "123 Fake Street",
      "address_2": "Unit 456",
      "city": "Brisbane",
      "state": "Queensland",
      "postcode": "4000",
      "country": "Australia",
      "phone": "123456789",
      "email": "john@example.com",
      "created_at": "2025-10-22T00:55:09+00:00",
      "updated_at": "2025-10-22T00:55:09+00:00"
    },
    "customer": {
      "first_name": "John",
      "last_name": "Doe",
      "phone": "123456789",
      "email": "john@example.com",
      "external_id": "1234",
      "created_at": "2025-10-22T00:55:09+00:00",
      "updated_at": "2025-10-22T00:55:09+00:00"
    },
    "products": [
      {
        "product_image_url": "https://d1no4rdxmwcuog.cloudfront.net/default/app-images/demonstration_image_1.jpg",
        "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,
        "uploads": [
          {
            "url": "https://d1no4rdxmwcuog.cloudfront.net/default/app-images/demonstration_image_1.jpg",
            "path": "app-images/demonstration_image_1.jpg",
            "type": "product_image"
          }
        ],
        "created_at": "2025-10-22T00:55:09+00:00",
        "updated_at": "2025-10-22T00:55:09+00:00"
      }
    ],
    "created_at": "2025-10-22T00:55:09+00:00",
    "updated_at": "2025-10-22T00:55:09+00:00"
  }
}
```

### 200 Form Submitted

```json
{
  "form_submission": {
    "submission_number": 1234,
    "type": "custom_form_submission",
    "form": {
      "form_id": 1,
      "customiser_id": 1,
      "label": "Custom Design Form",
      "description": "Lorem ipsum dolor",
      "email": "test@test.com",
      "subject": "My Custom Email Subject",
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z"
    },
    "responses": [
      {
        "field_id": "abcd1234",
        "value": "test@test.com",
        "name": "Your Email",
        "input_type": "EMAIL"
      }
    ],
    "created_at": "2024-01-01T00:00:00.000000Z"
  }
}
```