Skip to main content

Organizations API

List and manage organizations.

List organizations​

GET /api/v1/organizations
curl https://app.hooklistener.com/api/v1/organizations \
  -H "Authorization: Bearer hklst_your_api_key"

Response:

{
  "data": [
    {
      "id": "org_abc123",
      "name": "My Organization",
      "slug": "my-org",
      "inserted_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Update an organization​

PUT /api/v1/organizations/:id
curl -X PUT https://app.hooklistener.com/api/v1/organizations/org_abc123 \
  -H "Authorization: Bearer hklst_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "organization": {
      "name": "Updated Organization Name"
    }
  }'

Get organization plan​

GET /api/v1/organizations/:id/plan
curl https://app.hooklistener.com/api/v1/organizations/org_abc123/plan \
  -H "Authorization: Bearer hklst_your_api_key"

Response:

{
  "plan": {
    "name": "Pro",
    "features": {
      "max_endpoints": 50,
      "max_monitors": 20,
      "csv_export": true,
      "request_comparison": true,
      "static_tunnels": true,
      "audit_log": true
    }
  }
}

Generate signing secret​

POST /api/v1/organizations/:id/signing_secret
curl -X POST https://app.hooklistener.com/api/v1/organizations/org_abc123/signing_secret \
  -H "Authorization: Bearer hklst_your_api_key"

Roll signing secret​

POST /api/v1/organizations/:id/signing_secret/roll
curl -X POST https://app.hooklistener.com/api/v1/organizations/org_abc123/signing_secret/roll \
  -H "Authorization: Bearer hklst_your_api_key"

Get notification preferences​

GET /api/v1/organizations/:id/notification_preferences
curl https://app.hooklistener.com/api/v1/organizations/org_abc123/notification_preferences \
  -H "Authorization: Bearer hklst_your_api_key"

Update notification preferences​

PATCH /api/v1/organizations/:id/notification_preferences
curl -X PATCH https://app.hooklistener.com/api/v1/organizations/org_abc123/notification_preferences \
  -H "Authorization: Bearer hklst_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "notification_preferences": {
      "email_enabled": true,
      "slack_webhook_url": "https://hooks.slack.com/services/...",
      "telegram_bot_token": "123456:ABC-DEF...",
      "telegram_chat_id": "-1001234567890"
    }
  }'