HIhireart
Webhooks

onboarding.created 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.

postWebhookonboarding.created

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": "onboarding.created",
  "data": {
    "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
    "assignment_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86",
    "ready_to_work": true,
    "start_date": "2024-06-15",
    "job_name": "Customer Support Specialist",
    "status": "fully_cleared",
    "initiated_at": "2024-06-15T14:30:00Z",
    "completed_at": "2024-06-15T14:30:00Z",
    "assignment_term_status": "active",
    "status_changed_at": "2024-06-15T14:30:00Z",
    "offer_sent_at": "2024-06-15T14:30:00Z",
    "worker": {
      "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"
    },
    "pay_rate": {
      "salary_cents": 4500000,
      "hourly_rate_cents": 2163,
      "currency": "USD",
      "rate_type": "hourly"
    },
    "screenings": [
      {
        "object": "screening",
        "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
        "report_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86",
        "type": "criminal_background",
        "subtype": "county",
        "status": "pending",
        "result": "clear"
      }
    ],
    "documents": [
      {
        "object": "onboarding_document",
        "name": "Employment Agreement",
        "url": "https://cdn.example.com/document.pdf",
        "signed_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.