Register a New Webhook Endpoint

POST

/v1/webhooks

Coming soon — not yet available in this version. Register a new webhook endpoint to receive event notifications.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Example

{
    "url": "https://yourapp.com/webhooks/litemail",
    "events": [
        "mailbox.created",
        "domain.connected"
    ],
    "secret": "whsec_abc123"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/webhooks' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://yourapp.com/webhooks/litemail",
    "events": [
        "mailbox.created",
        "domain.connected"
    ],
    "secret": "whsec_abc123"
}'

Responses

🟠401

application/json

Unauthorized

Bodyapplication/json

Example

{
    "status": 401,
    "message": "Authentication required. Please login to continue."
}

🔴501

List Registered Webhooks

Delete a Webhook