Skip to main content
WEBHOOK
customer.created
{
  "eventId": "b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab",
  "type": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "data": {
    "customerId": "<string>",
    "customerType": "CONSUMER",
    "name": "<string>",
    "contact": {
      "email": "[email protected]",
      "msisdn": "<string>"
    },
    "identity": "<string>",
    "preferredLocale": "en-US",
    "humanReadableId": "29A-BY3Z-X78",
    "billing": {
      "method": "E_INVOICE",
      "currency": "USD",
      "email": "[email protected]",
      "address": {
        "street1": "500 S Main St",
        "city": "Natick",
        "zip": "01701",
        "country": "US",
        "street2": "Apt 1",
        "state": "CA",
        "region": "<string>",
        "attention": "<string>"
      },
      "defaultPaymentProfileId": "c1d2e3f4-a5b6-7890-1234-901234567890",
      "autoPay": true
    },
    "users": [
      {
        "userId": "<string>",
        "name": "<string>",
        "role": "MEMBER"
      }
    ],
    "contactPerson": {
      "userId": "<string>",
      "name": "<string>",
      "role": "MEMBER"
    },
    "shipping": {
      "name": "John Doe",
      "address": {
        "street1": "500 S Main St",
        "city": "Natick",
        "zip": "01701",
        "country": "US",
        "street2": "Apt 1",
        "state": "CA",
        "region": "<string>",
        "attention": "<string>"
      },
      "msisdn": "+15551234567",
      "instructions": "Leave at front door"
    },
    "metadata": {}
  }
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Body

application/json
​
eventId
string<uuid>
required

Unique identifier for this event (stable for the logical event; multiple delivery attempts reuse the same id). Use for idempotency.

Example:

"b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab"

​
type
string
required

The event type identifier.

Allowed value: "customer.created"
​
occurredAt
string<date-time>
required

RFC 3339 timestamp when the underlying change occurred.

​
data
object
required

Customer snapshot at the time of this event.

Response

Acknowledged