Webhooks

assignment.status_changed 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.

postWebhookassignment.status_changed

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": "assignment.status_changed",
  "data": {
    "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
    "status": "active",
    "status_changed_at": "2024-06-15T14:30:00Z",
    "start_date": "2024-06-15",
    "end_date": "2024-06-15",
    "classification": "w2",
    "pay_rate": {
      "salary_cents": 4500000,
      "hourly_rate_cents": 2163,
      "currency": "USD",
      "rate_type": "hourly"
    },
    "bill_rate": {
      "salary_cents": 4500000,
      "hourly_rate_cents": 2163,
      "currency": "USD",
      "rate_type": "hourly"
    },
    "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"
    },
    "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"
    },
    "work_location": {
      "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
      "description": "Handle inbound customer inquiries via phone, email, and chat.",
      "street1": "20 W 34th St",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    },
    "employer_of_record": {
      "name": "Acme Corp",
      "vendor_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86"
    },
    "visa": {
      "type": "us_eligible",
      "expiration_date": "2024-06-15"
    },
    "purchase_orders": [
      {
        "object": "purchase_order",
        "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
        "client_reference_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86",
        "cost_center": "Engineering",
        "original_amount_cents": 50000000,
        "currency": "USD",
        "start_date": "2024-06-15",
        "expiration_date": "2024-06-15"
      }
    ]
  }
}

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.