Companies

company.partner_offboarded

This event is triggered when a company is offboarded from a partner.

postWebhookcompany.partner_offboarded

Payload

company_idstring required

The unique identifier of the related company.

event_typestring required

The webhook event type identifier.

offboarding_datestring required

The date of the offboarding event.

Example payload

{
  "company_id": "ba310525-9282-40c9-8977-14d844bf891a",
  "event_type": "company.partner_offboarded",
  "offboarding_date": "2021-01-01T00:00:00Z"
}

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.