Contact Deleted Webhook Examples

​

What it is

​

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

​

Request

​

Response

HTTP/1.1 200 OK

• 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.

​

Basic Contact Deleted Example

​

Request

{
  "id": "evt_3456789012",
  "type": "contact.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactDeleted": {
    "id": "1824266594102064128",
    "nickName": "John Doe",
    "phoneNumber": "+16315551111",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

​

Response

HTTP/1.1 200 OK

​

Explanation

• Minimal Information: The contactDeleted object contains only essential information: id, nickName, phoneNumber, and updateTime.
• Null Values: The nickName field may be null if the contact didn’t have a nickname set.
• Update Time: The updateTime reflects when the contact was last modified before deletion.
• Contact ID: The id field contains the unique identifier of the deleted contact for reference.
• Phone Number: The phoneNumber is always present and formatted in E.164 format.