Project Webhook APIs

Enable applications and services to subscribe and register webhooks for notifications.

Retrieve webhooks for the specified project.

get

Fetches the available webhooks associated with the given project ID. This endpoint is intended for applications and services to access webhook configurations, enabling efficient notification management. It is crucial for developers to understand the webhooks set up for their projects to ensure proper integration and functionality.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/webhooks

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/webhooks HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "endpoints": [
    {
      "id": "text",
      "uid": "text",
      "external_id": {
        "id": "text"
      },
      "description": "text",
      "disabled": true,
      "secret": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "date_created": "2025-12-16T22:08:08.404Z",
      "date_modified": "2025-12-16T22:08:08.404Z",
      "url": "https://example.com",
      "filter_types": [
        "text"
      ],
      "channels": [
        "text"
      ],
      "rate_limit": 1
    }
  ]
}

Add a new webhook for project notifications

post

This endpoint allows users to register a new webhook for receiving notifications related to project activities. It is designed to facilitate real-time updates and integrations with external services. Ensure that the webhook endpoint is correctly configured to handle incoming notifications.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Body

application/json

filter_typesstring[]Optional

channelsstring[]Optional

idstringOptional

uidstringOptional

urlstringOptional

secretstringOptional

disabledbooleanOptional

descriptionstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/console/projects/{projectId}/webhooks

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/webhooks HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "filter_types": [
    "text"
  ],
  "channels": [
    "text"
  ],
  "id": "text",
  "uid": "text",
  "url": "text",
  "secret": "text",
  "disabled": true,
  "description": "text",
  "external_id": {
    "id": "text"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "endpoints": [
    {
      "id": "text",
      "uid": "text",
      "external_id": {
        "id": "text"
      },
      "description": "text",
      "disabled": true,
      "secret": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "date_created": "2025-12-16T22:08:08.404Z",
      "date_modified": "2025-12-16T22:08:08.404Z",
      "url": "https://example.com",
      "filter_types": [
        "text"
      ],
      "channels": [
        "text"
      ],
      "rate_limit": 1
    }
  ]
}

Update multiple webhook details for a project

put

This endpoint allows users to update all webhook endpoints associated with a specific project. It is designed for efficient bulk updates, ensuring that all relevant webhook configurations can be modified in a single request. This operation is crucial for maintaining accurate and up-to-date notification settings across various channels.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Body

application/json

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/console/projects/{projectId}/webhooks

HTTPcURLJavaScriptPython

PUT /console/projects/{projectId}/webhooks HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "endpoints": [
    {
      "filter_types": [
        "text"
      ],
      "channels": [
        "text"
      ],
      "id": "text",
      "uid": "text",
      "url": "text",
      "secret": "text",
      "disabled": true,
      "description": "text",
      "external_id": {
        "id": "text"
      },
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

{
  "endpoints": [
    {
      "id": "text",
      "uid": "text",
      "external_id": {
        "id": "text"
      },
      "description": "text",
      "disabled": true,
      "secret": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "date_created": "2025-12-16T22:08:08.404Z",
      "date_modified": "2025-12-16T22:08:08.404Z",
      "url": "https://example.com",
      "filter_types": [
        "text"
      ],
      "channels": [
        "text"
      ],
      "rate_limit": 1
    }
  ]
}

Update webhook details for the specified project.

put

This endpoint allows you to update the webhook configurations for a specific project. It is intended for users with the appropriate permissions to manage webhooks. Ensure that the provided webhook details are accurate to maintain proper notification functionality.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

uidstringRequired

Body

application/json

filter_typesstring[]Optional

channelsstring[]Optional

idstringOptional

uidstringOptional

urlstringOptional

secretstringOptional

disabledbooleanOptional

descriptionstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/console/projects/{projectId}/webhooks/{uid}

HTTPcURLJavaScriptPython

PUT /console/projects/{projectId}/webhooks/{uid} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "filter_types": [
    "text"
  ],
  "channels": [
    "text"
  ],
  "id": "text",
  "uid": "text",
  "url": "text",
  "secret": "text",
  "disabled": true,
  "description": "text",
  "external_id": {
    "id": "text"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "endpoints": [
    {
      "id": "text",
      "uid": "text",
      "external_id": {
        "id": "text"
      },
      "description": "text",
      "disabled": true,
      "secret": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "date_created": "2025-12-16T22:08:08.404Z",
      "date_modified": "2025-12-16T22:08:08.404Z",
      "url": "https://example.com",
      "filter_types": [
        "text"
      ],
      "channels": [
        "text"
      ],
      "rate_limit": 1
    }
  ]
}

Remove a specific webhook for the project.

delete

This endpoint allows users to remove a specified webhook endpoint associated with a project. It ensures that the webhook is no longer active for notifications. This operation is crucial for managing webhook subscriptions effectively and maintaining control over notification channels.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

uidstringRequired

Body

application/json

filter_typesstring[]Optional

channelsstring[]Optional

idstringOptional

uidstringOptional

urlstringOptional

secretstringOptional

disabledbooleanOptional

descriptionstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

delete

/console/projects/{projectId}/webhooks/{uid}

HTTPcURLJavaScriptPython

DELETE /console/projects/{projectId}/webhooks/{uid} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "filter_types": [
    "text"
  ],
  "channels": [
    "text"
  ],
  "id": "text",
  "uid": "text",
  "url": "text",
  "secret": "text",
  "disabled": true,
  "description": "text",
  "external_id": {
    "id": "text"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "endpoints": [
    {
      "id": "text",
      "uid": "text",
      "external_id": {
        "id": "text"
      },
      "description": "text",
      "disabled": true,
      "secret": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "date_created": "2025-12-16T22:08:08.404Z",
      "date_modified": "2025-12-16T22:08:08.404Z",
      "url": "https://example.com",
      "filter_types": [
        "text"
      ],
      "channels": [
        "text"
      ],
      "rate_limit": 1
    }
  ]
}

Retrieve message history for project webhooks

get

Fetches the audit logs of messages sent through the specified app webhook. This endpoint provides visibility into the message delivery status and history for the given project. Useful for debugging and tracking notifications sent to users.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

uidstringRequired

Query parameters

iteratorstringOptional

limitinteger · int32OptionalDefault: 10

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/webhooks/{uid}/history

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/webhooks/{uid}/history HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "docs": [
    {
      "id": "text",
      "msgId": "text",
      "url": "text",
      "response": "text",
      "responseStatusCode": 1,
      "status": "success",
      "timestamp": "2025-12-16T22:08:08.404Z",
      "trigger_type": "scheduled"
    }
  ],
  "iterator": "text",
  "limit": 1,
  "done": true
}

Retrieve stats for a specific webhook message.

get

This endpoint provides detailed statistics on message metrics for a specified webhook. It is intended for users to monitor the performance and delivery of notifications sent through the webhook. Access is restricted to authorized users associated with the given project.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

uidstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/webhooks/{uid}/stats

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/webhooks/{uid}/stats HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "success": 1,
  "errors": 1,
  "pending": 1,
  "sending": 1
}