Fulfilment Jobs Webhook

This webhook notifies your system when a new fulfilment job is created. It provides all the necessary order and voucher details required to begin the fulfilment process.

Event Name

fulfilment_job_created

Payload Schema

The webhook payload consists of an event string and a data object containing the job details.

Field Type Description
event string The name of the event.
data object An object containing the job details.

Data Object Fields

Field Type Description
id integer The unique identifier for the fulfilment job.
status string The current status of the job (e.g., new).
company object Information about the company associated with the job.
company.id integer The unique identifier for the company.
company.name string The name of the company.
company.company_terms_url string \| null URL to the company's terms and conditions.
tickets array A list of associated tickets (if any).
vouchers array A list of vouchers included in this fulfilment job.
vouchers[].id integer The unique identifier for the voucher.
vouchers[].code string The voucher code.
vouchers[].name string The name of the voucher/package.
vouchers[].type string The type of voucher (e.g., experience).
vouchers[].value string The monetary value of the voucher.
vouchers[].persons integer The number of persons covered by the voucher.
vouchers[].pdf_copy string A URL to download the PDF copy of the voucher.
vouchers[].valid_from string The start date of voucher validity.
vouchers[].valid_until string The end date of voucher validity.
created_at string The timestamp when the job was created.
option_name string The name of the selected option (e.g., Gift Card type).
customer_name string The name of the customer.
customer_email string The email address of the customer.
customer_phone string The contact phone number for the customer.
order_reference string Your internal or our provided order reference.
delivery_date string The required delivery date.
delivery_address object The delivery address details.
delivery_method_name string The name of the delivery method (e.g., Gift Envelope).

Example Payload

{
  "event": "fulfilment_job_created",
  "data": {
    "id": 1,
    "status": "new",
    "company": {
      "id": 1,
      "name": "The Swan Hotel",
      "company_terms_url": null
    },
    "tickets": [],
    "vouchers": [
      {
        "id": 100,
        "to": null,
        "code": "18485256",
        "from": null,
        "name": "Celebration Package",
        "type": "experience",
        "value": "200.00",
        "message": null,
        "persons": 2,
        "pdf_copy": "https://api.smart-gift.co.uk/fulfilment/assets/1/voucher-pdf/1234/1",
        "valid_from": "2026-05-26 11:36:23",
        "valid_until": "2126-05-26 11:36:23"
      }
    ],
    "created_at": "2026-05-26T11:36:23.000000Z",
    "option_name": "Gift Card in a Luxury Envelope",
    "received_at": null,
    "customer_name": "Danny Butterman",
    "delivery_date": "2026-05-26 11:36:23",
    "customer_email": "qukyn@mailinator.com",
    "customer_phone": "+1 (428) 566-8373",
    "order_reference": "45xfBJxVygAMc3DR",
      "delivery_address": {
        "city": "Sandford",
        "line1": "High Street",
        "line2": null,
        "county": "Gloucestershire",
        "postcode": "SF1 1FB",
        "last_name": "Angel",
        "first_name": "Nicholas"
      },
    "option_description": "Delivered in a decorative, padded envelope",
    "tracking_reference": null,
    "delivery_method_name": "Gift Envelope",
    "delivery_method_description": "Gift envelope (Fulfilled by Courier)"
  }
}