REremote-com
Terminations

offboarding.review_started

This event is triggered whenever an offboarding request starts being reviewed.

postWebhookoffboarding.review_started

Payload

company_idstring required

The unique identifier of the related company.

employment_idstring required

The unique identifier of the related employment.

event_typestring required

The webhook event type identifier.

offboarding_idstring required

The unique identifier of the offboarding. Use this to query GET /v2/offboardings/{id}.

offboarding_request_idstring nullable required

The unique identifier of the offboarding request. Null when the offboarding was not created from an offboarding request, for example when Remote creates it automatically because a fixed-term contract is ending. Use offboarding_id to identify the offboarding instead.

Example payload

{
  "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59",
  "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99",
  "event_type": "offboarding.review_started",
  "offboarding_id": "ba310525-9282-40c9-8977-14d844bf891a",
  "offboarding_request_id": "0073fcb5-b669-4e4a-b963-2a47744e75a1"
}

Response

Any 200 response confirms that the webhook was delivered.

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.