Webhooks

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

Name	Description
`company.created`	This event occurs when an company is created.
`company.archived`	This event occurs when an company has been archived.
`company.merged`	This event occurs when two or more companies have been merged.
`company.updated`	This event occurs when an company has been updated.
`company.onboarding.done`	This event occurs when an company has completed onboarding.
`company.onboarding.late`	This event occurs when an company’s onboarding becomes overdue.
`company.onboarding.stuck`	This event occurs when an company’s onboarding status has been changed to stuck.
`company.relationship.customer`	This event occurs when an company’s relationship has been changed to customer.
`company.relationship.prospect`	This event occurs when an company’s relationship has been changed to prospect.
`tracker.visit`	This event occurs when the tracker registers a completed visit to a website.
`contract.created`	This event occurs when a contract is created.
`contract.renewed`	This event occurs when a contract is renewed.
`contract.ended`	This event occurs when a contract is ended.
`invoice.finalized`	This event occurs when an invoice email is sent to the customer.
`invoice.status.paid`	This event occurs when an invoice has been paid in full.
`invoice.status.uncollectible`	This event occurs when an invoice has been marked as uncollectible.
`invoice.status.overdue`	This event occurs when an invoice becomes overdue.
`invoice.status.voided`	This event occurs when an invoice has been voided and is no longer able to be acted on.
`invoice.status.payment_pending`	This event occurs when payment is requested for an invoice but not completed.

Example Events

Company Event

Contract Event

Invoice Event

{
  "data": {
    "amountDue": 3.50,
    "amountDueInSmallestUnit": 350,
    "amountPaid": 0.0,
    "amountRemaining": 0.0,
    "contract": {
      "contractName": "My Contract",
      "contractStatus": "LIVE",
      "metadata": {
        "id": "96d612a8-b086-4dae-9f10-a12796f30c55"
      }
    },
    "currency": "usd",
    "due": "2024-02-01T19:42:00.656805391Z",
    "invoiceLineItems": [
      {
        "description": "My Amazing Product",
        "metadata": {
          "id": "96d612a8-b086-4dae-9f10-a12796f30c55"
        }
      }
    ],
    "invoiceNumber": "LAM-23423",
    "invoicePeriodEnd": "2024-01-26T00:00:00Z",
    "invoicePeriodStart": "2024-01-26T00:00:00Z",
    "invoiceUrl": "https://customeros.ai/invoices/96d612a8-b086-4dae-9f10-a12796f30c55",
    "metadata": {
      "created": "2024-02-01T19:42:00.656805391Z",
      "id": "96d612a8-b086-4dae-9f10-a12796f30c55"
    },
    "note": "",
    "company": {
      "customerOsId": "C-XSC-SDF",
      "metadata": {
        "id": "96d612a8-b086-4dae-9f10-a12796f30c55"
      },
      "name": "Acme Corp"
    },
    "paid": false,
    "status": "DUE",
    "subtotal": 0.0,
    "taxDue": 0.0
  },
  "event": "invoice.finalized"
}

Tracker Event

{
  "type": "business",
  "name": "Universidad Americana (UAM)",
  "domain": "uamv.edu.ni",
  "website": "https://uamv.edu.ni",
  "geo": {
    "country": "Nicaragua",
    "country_code": "NI",
   },
    "profiles": {
      "crunchbase": {
        "handle": "",
        "url": null
      },
      "linkedin": {
        "handle": "bolsa-de-trabajo-uam-nicaragua",
        "url": "https://linkedin.com/companies/bolsa-de-trabajo-uam-nicaragua"
      },
      "facebook": {
        "handle": "UniversidadAmericana.UAM",
        "url": "https://www.facebook.com/UniversidadAmericana.UAM"
      },
      "twitter": {
        "handle": "uamnica",
        "url": "https://twitter.com/uamnica"
      },
      "instagram": {
        "handle": "",
        "url": null
      },
      "youtube": {
        "handle": "",
        "url": null
      }
    }
  }
}

Getting Started

CustomerOS Quickstart

Automate with CustomerOS

Data Objects

Managing CustomerOS

Working with the API

Webhook URL

Handling failure

Webhook object

Webhook Event Types

Example Events

Getting Started

CustomerOS Quickstart

Automate with CustomerOS

Data Objects

Managing CustomerOS

Working with the API

​Webhook URL

​Handling failure

​Webhook object

​Webhook Event Types

​Example Events

Webhook URL

Handling failure

Webhook object

Webhook Event Types

Example Events