API Reference

offboarding.submitted

webhook
offboarding.submitted

This event is triggered when an offboarding is created, either from a submitted offboarding request or by Remote (for example automatically, when a fixed-term contract is ending).

Payload
string
required

The unique identifier of the related company.

string
required

The unique identifier of the related employment.

string
required

The webhook event type identifier.

string
required

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

string | null
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.

Response
2XX

Any 200 response confirms that the webhook was delivered.

Updated 7 months ago

Did this page help you?
LoadingLoading…

Updated 7 months ago

Did this page help you?