Webhook events

Order created

Copy page

Delivered when Sign Customiser records a completed order for your organisation. If your Store has dual quantities enabled, the payload also includes inch measurements and authored_units.

WEBHOOKorder:created

Verification

Sign Customiser delivers this webhook to your own endpoint and signs the payload withx-webhook-timestampandx-webhook-signature. Validate both values before processing the payload.

Delivery headers

x-webhook-timestampstringheaderrequired

Unix timestamp used when generating the delivery signature.

Example: 1704067200

x-webhook-signaturestringheaderrequired

SHA-256 HMAC signature for the order:created payload.

Example: YOUR_GENERATED_SIGNATURE

Payload

orderobjectbody

Payload example

{
  "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": "2024-01-01T00:00:00+00:00",
      "updated_at": "2024-01-01T00:00:00+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": "2024-01-01T00:00:00+00:00",
      "updated_at": "2024-01-01T00:00:00+00:00"
    },
    "customer": {
      "first_name": "John",
      "last_name": "Doe",
      "phone": "123456789",
      "email": "john@example.com",
      "external_id": "1234",
      "created_at": "2024-01-01T00:00:00+00:00",
      "updated_at": "2024-01-01T00:00:00+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,
        "customiser_language_id": 1,
        "customiser_language_code": "en",
        "customiser_default_language_code": "en",
        "customiser_languages_version": "example-version",
        "customiser_language_hash": "example-hash",
        "customer_display_snapshot": {
          "line_items": {
            "Text": "Hello World"
          },
          "fields": {
            "text": {
              "label": "Text",
              "value": "Hello World"
            }
          }
        },
        "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"
          }
        ],
        "logo_upload": null,
        "width_cm": 10,
        "height_cm": 10,
        "length_cm": 10,
        "border_margin_cm": null,
        "mounting_letter_part": null,
        "created_at": "2024-01-01T00:00:00+00:00",
        "updated_at": "2024-01-01T00:00:00+00:00",
        "letter_heights_cm": null,
        "width_in": 3.9370079,
        "height_in": 3.9370079,
        "length_in": 3.9370079,
        "border_margin_in": null,
        "authored_units": {
          "width_cm": "centimetres",
          "height_cm": "centimetres",
          "length_cm": "centimetres"
        }
      }
    ],
    "legacy_products": [],
    "created_at": "2024-01-01T00:00:00+00:00",
    "updated_at": "2024-01-01T00:00:00+00:00"
  }
}

Order created

curl https://your-app.example.com/sign-customiser/webhooks \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-webhook-timestamp: 1704067200' \
  --header 'x-webhook-signature: YOUR_GENERATED_SIGNATURE' \
  --data '{
  "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": "2024-01-01T00:00:00+00:00",
      "updated_at": "2024-01-01T00:00:00+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": "2024-01-01T00:00:00+00:00",
      "updated_at": "2024-01-01T00:00:00+00:00"
    },
    "customer": {
      "first_name": "John",
      "last_name": "Doe",
      "phone": "123456789",
      "email": "john@example.com",
      "external_id": "1234",
      "created_at": "2024-01-01T00:00:00+00:00",
      "updated_at": "2024-01-01T00:00:00+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,
        "customiser_language_id": 1,
        "customiser_language_code": "en",
        "customiser_default_language_code": "en",
        "customiser_languages_version": "example-version",
        "customiser_language_hash": "example-hash",
        "customer_display_snapshot": {
          "line_items": {
            "Text": "Hello World"
          },
          "fields": {
            "text": {
              "label": "Text",
              "value": "Hello World"
            }
          }
        },
        "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"
          }
        ],
        "logo_upload": null,
        "width_cm": 10,
        "height_cm": 10,
        "length_cm": 10,
        "border_margin_cm": null,
        "mounting_letter_part": null,
        "created_at": "2024-01-01T00:00:00+00:00",
        "updated_at": "2024-01-01T00:00:00+00:00",
        "letter_heights_cm": null,
        "width_in": 3.9370079,
        "height_in": 3.9370079,
        "length_in": 3.9370079,
        "border_margin_in": null,
        "authored_units": {
          "width_cm": "centimetres",
          "height_cm": "centimetres",
          "length_cm": "centimetres"
        }
      }
    ],
    "legacy_products": [],
    "created_at": "2024-01-01T00:00:00+00:00",
    "updated_at": "2024-01-01T00:00:00+00:00"
  }
}'

{
  "ok": true
}