Webhooks and Events API Reference

Mock API reference used by the interactive docs explorer.

Servers

webhooks operations

List webhook endpoints

GET /webhooks/endpoints — Returns configured webhook endpoints.

Operation ID: listWebhookEndpoints.

Required scopes: webhooks:read.

Responses

200 — Success

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "data": [
    {
      "id": "wh_001",
      "url": "https://example.local/hooks/monetizekit"
    }
  ]
}

Create webhook endpoint

POST /webhooks/endpoints — Registers a new webhook endpoint.

Operation ID: createWebhookEndpoint.

Required scopes: webhooks:write.

Request schema

{
  "type": "object",
  "required": [
    "url",
    "events"
  ],
  "properties": {
    "url": {
      "type": "string"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Request example

{
  "url": "https://example.local/hooks/monetizekit",
  "events": [
    "customer.created"
  ]
}

Responses

201 — Created

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "secret": {
      "type": "string"
    }
  }
}

{
  "id": "wh_002",
  "secret": "whsec_placeholder"
}