HIhireart
Webhooks

offer.marked_ready event

The payload is the resource's current state at delivery time, rebuilt per attempt. The POST body is a signed envelope { id, event, data }, where data is the schema below. Verify the X-HireArt-Signature header before trusting the body — see the Webhooks section overview for how.

postWebhookoffer.marked_ready

Payload

idstring required

Stable id for this delivery; the same id repeats on every retry, so use it to dedupe.

eventstring required

The event type, e.g. assignment.updated.

Example payload

{
  "id": "d47e1f8a-3c2b-4a90-9f6d-8b21c4e5f0a1:42",
  "event": "offer.marked_ready",
  "data": {
    "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
    "status": "pending",
    "status_changed_at": "2024-06-15T14:30:00Z",
    "additional_details": "Hybrid schedule, 3 days on-site.",
    "terms": [
      {
        "object": "offer_term",
        "type": "salary",
        "amount_cents": 15000,
        "currency": "USD",
        "cadence": "annually",
        "context": "Performance bonus",
        "start_date": "2024-06-15"
      }
    ],
    "employer_start_date": "2024-06-15",
    "employer_start_preference": "as_soon_as_possible",
    "initiated_at": "2024-06-15T14:30:00Z",
    "references_checked_at": "2024-06-15T14:30:00Z",
    "sent_at": "2024-06-15T14:30:00Z",
    "job": {
      "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
      "name": "Customer Support Specialist",
      "employer_name": "Acme Corp",
      "employer_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86",
      "logo_url": "https://cdn.example.com/image.jpg"
    },
    "applicant": {
      "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
      "full_name": "Jane Doe",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@example.com",
      "phone": "+1 (555) 555-5555"
    },
    "application_id": "e3d53e91-6187-4184-a084-75a7532e5fca",
    "worker_id": "1ccf6e61-376c-47d3-8a63-a8ee112e83a2",
    "created_at": "2024-06-15T14:30:00Z",
    "updated_at": "2024-06-15T14:30:00Z"
  }
}

Response

Return any 2xx to acknowledge receipt; non-2xx or a timeout is retried.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.