Webhook

Outgoing Job Events

Webhook deliveries are JSON POST requests sent from Shiplah to your configured endpoint when visible delivery jobs change.

Events

EventWhen it is sent
delivery_job.createdA visible delivery job is created.
delivery_job.updatedA visible delivery job is updated.
delivery_job.status_changedThe delivery job status changes.

Payload

{
  "event": "delivery_job.status_changed",
  "occurred_at": "2026-05-21T10:00:00.000Z",
  "organization": {
    "id": "org-id",
    "type": "upstream"
  },
  "job": {
    "id": "job-id",
    "marking_number": "MARK-001",
    "batch_number": "BATCH-001",
    "normalized_status": "completed",
    "updated_at": "2026-05-21T10:00:00.000Z"
  }
}

Payload Fields

NameTypeDescription
eventstringWebhook event name.
occurred_atdatetimeEvent creation time.
organization.idstringOrganization id scoped to the webhook subscription.
organization.typestringOrganization type.
job.idstringDelivery job id.
job.marking_numberstringMarking Number.
job.batch_numberstring or nullBatch Number.
job.normalized_statusstringCurrent platform status code. See Reference.
job.updated_atdatetimeLatest job update time.

Authentication Options

The integrations page supports no auth, Basic auth, Bearer token, and a custom header. Secrets are stored by organization and are not shown after saving.