Webhook URL

To receive Webhook notifications from CustomerOS, reach out to the CustomerOS team with the URL you want an HTTPS POST request to be made to.

Handling failure

CustomerOS uses Temporal to provide durable execution.

CustomerOS will resend each webhook until 1 hour has elapsed with the interval between each retry doubling in length.

Webhook object

event
string

The type of the event. See Webhook Event Types.

data
object

This contains the payload of the event.

Webhook Event Types

NameDescription
organization.createdThis event occurs when an organization is created.
organization.archivedThis event occurs when an organization has been archived.
organization.mergedThis event occurs when two or more organizations have been merged.
organization.updatedThis event occurs when an organization has been updated.
organization.onboarding.doneThis event occurs when an organization has completed onboarding.
organization.onboarding.lateThis event occurs when an organization’s onboarding becomes overdue.
organization.onboarding.stuckThis event occurs when an organization’s onboarding status has been changed to stuck.
organization.relationship.customerThis event occurs when an organization’s relationship has been changed to customer.
organization.relationship.prospectThis event occurs when an organization’s relationship has been changed to prospect.
tracker.visitThis event occurs when the tracker registers a completed visit to a website.
contract.createdThis event occurs when a contract is created.
contract.renewedThis event occurs when a contract is renewed.
contract.endedThis event occurs when a contract is ended.
invoice.finalizedThis event occurs when an invoice email is sent to the customer.
invoice.status.paidThis event occurs when an invoice has been paid in full.
invoice.status.uncollectibleThis event occurs when an invoice has been marked as uncollectible.
invoice.status.overdueThis event occurs when an invoice becomes overdue.
invoice.status.voidedThis event occurs when an invoice has been voided and is no longer able to be acted on.

Example Events