Webhook

Webhook

View user webhook

get

Path parameters

user_idintegerRequired

ID of the user

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: UserWebhook

401

Unauthenticated

404

User not found

get

/api/organizations/{organization}/webhooks

HTTPcURLJavaScriptPython

GET /api/organizations/{organization}/webhooks HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "UserWebhook",
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "webhook_url": "text",
      "date": "2026-03-21T11:39:04.121Z"
    }
  ]
}

Show specific user webhook

get

Path parameters

idintegerRequired

ID of the user webhook

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: UserWebhook

401

Unauthenticated

404

User webhook not found

get

/api/organizations/{organization}/webhooks/{webhook}

HTTPcURLJavaScriptPython

GET /api/organizations/{organization}/webhooks/{webhook} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "UserWebhook",
  "data": {
    "id": 1,
    "user_id": 1,
    "webhook_url": "text",
    "date": "2026-03-21T11:39:04.121Z"
  }
}

Create a new user webhook

post

Body

application/json

webhook_urlstring · min: 5 · max: 500RequiredExample: https://example.com/webhook

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: UserWebhook

400

Bad request

application/json

401

Unauthenticated

post

/api/organizations/{organization}/webhooks/

HTTPcURLJavaScriptPython

POST /api/organizations/{organization}/webhooks/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "webhook_url": "https://example.com/webhook"
}

{
  "success": true,
  "message": "UserWebhook",
  "data": {
    "id": 1,
    "user_id": 1,
    "webhook_url": "text",
    "date": "2026-03-21T11:39:04.121Z"
  }
}

Get all webhook services

get

Path parameters

organizationintegerRequired

ID of the organization

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: services

401

Unauthenticated

get

/api/organizations/{organization}/webhooks/services

HTTPcURLJavaScriptPython

GET /api/organizations/{organization}/webhooks/services HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "services",
  "data": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "created_at": "2026-03-21T11:39:04.121Z",
      "updated_at": "2026-03-21T11:39:04.121Z"
    }
  ]
}

Get webhook events for a specific service

get

Path parameters

organizationintegerRequired

ID of the organization

Query parameters

service_idintegerRequired

ID of the webhook service

Responses

200

Successful operation

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: events

400

Bad request

application/json

401

Unauthenticated

get

/api/organizations/{organization}/webhooks/events

HTTPcURLJavaScriptPython

GET /api/organizations/{organization}/webhooks/events?service_id=1 HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "events",
  "data": [
    {
      "id": 1,
      "webhook_service_id": 1,
      "name": "text",
      "description": "text",
      "is_active": true,
      "created_at": "2026-03-21T11:39:04.121Z",
      "updated_at": "2026-03-21T11:39:04.121Z"
    }
  ]
}