Registers a new webhook endpoint to receive event notifications.

POST

/v1/webhook

Registers a new webhook endpoint for event notifications.

Request

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Webhook registered successfully.

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://dev.api.fieldedge.com/leads/v1/webhook' \
--header 'Content-Type: application/json' \
--data-raw '{
    "callbackUrl": "https://api.example.com/webhooks/receive",
    "headers": {
        "x-api-key": "12345-ABCDE-67890",
        "x-source": "FieldEdge"
    }
}'

Response Example

201 - response

{
    "data": {
        "webhookId": "9b8df6c2-fc64-4be6-a187-cde2b27cb515",
        "message": "Webhook registered successfully."
    }
}

Modified at 2026-02-26 12:18:17

Updates an existing customer