latestOpenAPI 3.0.02026-07-243339471.1 MB

74c95058b11f

Webhooks

Create a Webhook

This API endpoint creates a new Webhook using details of the receiver such as the endpoint URL and the authMechanism. Auth mechanism can be either API key or OIDC. Use dropdown beside input in body parameters to change authMechanism and provide respective parameters for the authentication type.

post/network-services/v1/webhooks

Request body

inputWebhookRequestPayload required— unresolved $ref

Response

Creating new webhook.

Example response

{
  "items": {
    "name": "webhook-1",
    "id": "26dd26c8-8a6a-4d",
    "type": "network-services",
    "generation": 1,
    "createdAt": "2025-08-12T01:50:03Z",
    "updatedAt": "2025-08-12T01:50:03Z",
    "success": true,
    "message": "Webhook registered!",
    "hmacKey": "5e175c081f53ca19894cbb6d541560f5c5e9a0754ae69639ef4d56b774b4e04e"
  }
}