Webhook events

Form submitted

deprecated

Copy page

Deprecated. Delivered when a customer submits a Sign Customiser form workflow.

WEBHOOKform:submitted

Overview

Read submissions from GET /api/v3/quotes with the quotes:read scope instead, and deduplicate on the quote id. This webhook still fires on every submission with an unchanged payload, and has no removal date.

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 form:submitted payload.

Example: YOUR_GENERATED_SIGNATURE

Payload

form_submissionobjectbody

Payload example

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

Form submitted

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 '{
  "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"
  }
}'

{
  "ok": true
}