Contact Created Webhook Examples

🚧
Prerequisites

The webhook endpoint URL should be provided by your server instead of YCloud. Make sure to replace the URL with your actual webhook endpoint URL.

Make sure that your webhook endpoint is listening for the appropriate event types. See also Configure Webhooks, Retrieve a webhook endpoint API.

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

Contact Created Example

{
  "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": "[email protected]",
    "sourceType": "api",
    "sourceId": "import_batch_123",
    "sourceUrl": "https://example.com/signup",
    "lastSeen": "2024-01-01T11:59:00.000Z",
    "lastConnectedNumber": "+16315552222",
    "ownerEmail": "[email protected]",
    "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
    }
  }
}

Notes

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.