Contact Created Webhook Examples

For the exhaustive schema-derived catalog, see all examples.

What it is

Handle contact creation events.

Before you begin

Create a public HTTPS endpoint in your application.
Configure a YCloud webhook endpoint for the event types you need.
Store the endpoint signing secret securely.
Make event processing idempotent.

How it works

YCloud sends an HTTP POST request when the event occurs. Verify the signature, durably record the event, return a 2xx response, and process slow work asynchronously.

Request

The scenarios below show requests delivered to your webhook URL. Treat the event id as the delivery identifier and use type to route the payload.

Response

Return a 2xx status after accepting the event.

HTTP/1.1 200 OK

For endpoint setup, signature validation, and retry behavior, see Configure webhooks.

Occurs when a new contact is created. The webhook payload contains the full contact information that was created.

Contact Created Example

Request

{
  "id": "evt_2345678901",
  "type": "contact.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactCreated": {
    "id": "1824266594102064128",
    "nickName": "John Doe",
    "realName": "John Smith",
    "phoneNumber": "+16315551111",
    "countryCode": "US",
    "countryName": "United States",
    "email": "john.doe@example.com",
    "sourceType": "api",
    "sourceId": "import_batch_123",
    "sourceUrl": "https://example.com/signup",
    "lastSeen": "2024-01-01T11:59:00.000Z",
    "lastConnectedNumber": "+16315552222",
    "ownerEmail": "owner@example.com",
    "tags": [
      "premium",
      "newsletter"
    ],
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-01T12:00:00.000Z",
    "blocked": false,
    "customAttributes": {
      "company": "YCloud Inc",
      "age": 25
    }
  }
}

Response

Acknowledge the delivery after durably accepting the event.

HTTP/1.1 200 OK

Explanation

Full Contact Information: The contactCreated object contains all available contact information at the time of creation.
Custom Attributes: The customAttributes field contains any custom data associated with the contact.
Tags: The tags array contains any tags assigned to the contact during creation.

Getting Started

Guides

Endpoints

Webhooks

Contact Created Webhook Examples

What it is

Before you begin

How it works

Request

Response

Contact Created Example

Request

Response

Explanation

​What it is

​Before you begin

​How it works

​Request

​Response

​Contact Created Example

​Request

​Response

​Explanation

What it is

Before you begin

How it works

Request

Response

Contact Created Example

Request

Response

Explanation