Create webhook

POST

/v1/webhooks

Creates a webhook endpoint for partner events.
URL must be HTTPS (HTTP allowed only for localhost development).

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

API Key

Add parameter in header

X-API-SECRET

Example:

X-API-SECRET: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Webhook created

Body

🟠400BadRequest

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://devapi.immigraflow.com/v1/webhooks' \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-SECRET: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://example.com",
    "description": "string",
    "signing_secret": "string"
}'

Response Example

201 - Example 1

{
    "success": true,
    "webhook": {
        "id": 0,
        "url": "http://example.com",
        "description": "string",
        "is_active": true,
        "has_signing_secret": true,
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z",
        "last_delivery_at": "2019-08-24T14:15:22.123Z",
        "last_delivery_http_status": 0,
        "last_delivery_error": "string"
    }
}

Modified at 2026-04-20 08:31:25

List webhooks

Get webhook