Create New Webhook Endpoint/Destination

POST

/v2/webhooks/endpoints

Create a new webhook endpoint and choose which events it should receive. The response includes a signing secret used to verify webhook requests—save it securely, as it is only returned once and cannot be retrieved later.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.zapmail.ai/api/v2/webhooks/endpoints' \
--header 'x-auth-zapmail;' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://example.com/hooks/zapmail",
    "enabled_events": [
        "domain.updated",
        "mailbox.updated"
    ]
}'

Response Example

{
    "status": 201,
    "message": "Webhook endpoint created",
    "data": {
        "id": "uuid",
        "url": "https://example.com/webhooks/zapmail",
        "enabled_events": [
            "domain.updated",
            "mailbox.updated"
        ],
        "status": "active",
        "secret": "whsec_123456",
        "created_at": "2026-07-21T00:00:00.000Z",
        "updated_at": "2026-07-21T00:00:00.000Z"
    }
}

Modified at 2026-09-09 08:09:02

Get Webhook Endpoints/Destinations

Update a Specific Endpoint