CloudTruth

CloudTruth Webhooks API

The webhooks API from CloudTruth — 2 operation(s) for webhooks.

GitHub OpenAPI

Operations 6

GET /api/v1/webhooks/ Webhooks list #
POST /api/v1/webhooks/ Webhooks create #
GET /api/v1/webhooks/{id}/ Webhooks retrieve #
PUT /api/v1/webhooks/{id}/ Webhooks update #
PATCH /api/v1/webhooks/{id}/ Webhooks partial update #
DELETE /api/v1/webhooks/{id}/ Webhooks destroy #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cloudtruth/refs/heads/main/openapi/cloudtruth-webhooks-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudtruth/refs/heads/main/json-schema/cloudtruth-aws-push-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudtruth/refs/heads/main/json-schema/cloudtruth-parameter-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudtruth/refs/heads/main/json-schema/cloudtruth-value-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudtruth/refs/heads/main/json-schema/cloudtruth-aws-pull-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudtruth/refs/heads/main/json-schema/cloudtruth-patched-aws-pull-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudtruth/refs/heads/main/json-schema/cloudtruth-azure-key-vault-push-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cloudtruth:cloudtruth-webhooks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudtruth-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: CloudTruth Management Webhooks API
  version: v1
  description: CloudTruth centralizes your configuration parameters and secrets making them easier to manage and use as a team.
  contact:
    name: CloudTruth Support
    email: support@cloudtruth.com
tags:
- name: Webhooks
paths:
  /api/v1/webhooks/:
    get:
      operationId: webhooks_list
      parameters:
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Webhooks
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWebHooksList'
          description: ''
      summary: Webhooks list
      x-summary-source: derived
    post:
      operationId: webhooks_create
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebHooks'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WebHooks'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WebHooks'
        required: true
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebHooks'
          description: ''
      summary: Webhooks create
      x-summary-source: derived
  /api/v1/webhooks/{id}/:
    get:
      operationId: webhooks_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
          description: Primary key for webhook
        required: true
      tags:
      - Webhooks
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebHooks'
          description: ''
      summary: Webhooks retrieve
      x-summary-source: derived
    put:
      operationId: webhooks_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
          description: Primary key for webhook
        required: true
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebHooks'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WebHooks'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WebHooks'
        required: true
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebHooks'
          description: ''
      summary: Webhooks update
      x-summary-source: derived
    patch:
      operationId: webhooks_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
          description: Primary key for webhook
        required: true
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWebHooks'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedWebHooks'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedWebHooks'
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebHooks'
          description: ''
      summary: Webhooks partial update
      x-summary-source: derived
    delete:
      operationId: webhooks_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
          description: Primary key for webhook
        required: true
      tags:
      - Webhooks
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Webhooks destroy
      x-summary-source: derived
components:
  schemas:
    PaginatedWebHooksList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/WebHooks'
    PatchedWebHooks:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Primary key for webhook
        name:
          type: string
          description: Webhook name
        organization:
          type: string
          description: A unique identifier for the organization.
        event_types:
          type: array
          items:
            $ref: '#/components/schemas/EventTypesEnum'
          description: Events that trigger this hook
        type:
          allOf:
          - $ref: '#/components/schemas/WebHooksTypeEnum'
          description: 'The type of this web hook.


            * `slack` - Slack Notification

            * `generic` - Generic'
        configuration:
          description: '

            The configuration necessary for this web hook.  The contents of this depend on the

            type of web hook:


            Generic Web Hooks:

            - url: (required) the URL to deliver the webhook to.

            - verify: if False, cert verification is disabled (defaults to True).

            - username: basic auth username, a password must also be provided (defaults to None).

            - password: basic auth password, a username must also be provided.   Stored encrypted (defaults to None).

            - token: Bearer token.  Stored encrypted (defaults to None).


            Slack Web Hooks:

            - token: (required) the token for connecting to Slack.

            - channel: (required) the Slack channel to deliver messages to.  Stored encrypted.

            - username: (required) the username to post under in Slack.

            '
        last_run:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: the last time this webhook was run.
        last_error:
          description: '

            The last error that occurred when sending this webhook.   This includes

            - timestamp: the timestamp associated with the failure.

            - code: the error for this error, if any.

            - text: the error text for this error.

            '
    WebHooks:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Primary key for webhook
        name:
          type: string
          description: Webhook name
        organization:
          type: string
          description: A unique identifier for the organization.
        event_types:
          type: array
          items:
            $ref: '#/components/schemas/EventTypesEnum'
          description: Events that trigger this hook
        type:
          allOf:
          - $ref: '#/components/schemas/WebHooksTypeEnum'
          description: 'The type of this web hook.


            * `slack` - Slack Notification

            * `generic` - Generic'
        configuration:
          description: '

            The configuration necessary for this web hook.  The contents of this depend on the

            type of web hook:


            Generic Web Hooks:

            - url: (required) the URL to deliver the webhook to.

            - verify: if False, cert verification is disabled (defaults to True).

            - username: basic auth username, a password must also be provided (defaults to None).

            - password: basic auth password, a username must also be provided.   Stored encrypted (defaults to None).

            - token: Bearer token.  Stored encrypted (defaults to None).


            Slack Web Hooks:

            - token: (required) the token for connecting to Slack.

            - channel: (required) the Slack channel to deliver messages to.  Stored encrypted.

            - username: (required) the username to post under in Slack.

            '
        last_run:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: the last time this webhook was run.
        last_error:
          description: '

            The last error that occurred when sending this webhook.   This includes

            - timestamp: the timestamp associated with the failure.

            - code: the error for this error, if any.

            - text: the error text for this error.

            '
      required:
      - event_types
      - id
      - last_run
      - name
      - organization
      - type
    EventTypesEnum:
      enum:
      - parameter_created
      - parameter_updated
      - parameter_deleted
      - template_created
      - template_updated
      - template_deleted
      - project_created
      - project_updated
      - project_deleted
      - environment_created
      - environment_updated
      - environment_deleted
      - value_created
      - value_updated
      - value_deleted
      type: string
      description: '* `parameter_created` - Parameter created

        * `parameter_updated` - Parameter updated

        * `parameter_deleted` - Parameter deleted

        * `template_created` - Template created

        * `template_updated` - Template updated

        * `template_deleted` - Template deleted

        * `project_created` - Project created

        * `project_updated` - Project updated

        * `project_deleted` - Project deleted

        * `environment_created` - Environment created

        * `environment_updated` - Environment updated

        * `environment_deleted` - Environment deleted

        * `value_created` - Value created

        * `value_updated` - Value updated

        * `value_deleted` - Value deleted'
    WebHooksTypeEnum:
      enum:
      - slack
      - generic
      type: string
      description: '* `slack` - Slack Notification

        * `generic` - Generic'
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey
      description: "\nUse your CloudTruth API Key to authenticate to the API.  You can get\nan API Key by creating a Service Account.  During setup of the Service\nAccount you will generate a long-lived API key intended for use by automation\nand API clients.  Access through the service account will be audited separately\nfrom any other user.\n\nIf you are just trying to use the API in a normal workflow, this is likely the\nauthentication mechanism you want to use.\n\nTo use the API Key, place your API Key in the Authorization header as 'Api-Key APIKEY', where\nAPIKEY is your CloudTruth API Key.  For example:\n\n    Authorization: Api-Key fskur.ghlsiudhrg84so938r5u\n        "
    JWTAuth:
      in: header
      name: Authorization
      type: apiKey
      description: "\nUse your JWT to authenticate to the API.  This is how the CloudTruth\nWeb UI authenticates to the backend.  It requires a user to have already logged in\nand gotten a JWT from the login process.  This is usually done by an Auth0 authentication\nflow from one of the Auth0 javascript libraries.  Alternatively, you can pull the\nJWT from your browser if you have a logged in session with the CloudTruth UI.\n\nThis authentication mechanism is intended for deeper integrations into the CloudTruth\nsystem, where you want to handle the user logins directly in your application.  For\nnormal API use, you likely want the Api-Key authentication header and not this one.\n\nTo use the JWT, place your JWT in the Authorization header as 'Bearer JWT', where\nJWT is your JWT.  For example:\n\n    Authorization: Bearer eyJhbGciOiJIkuydfy.eyJzdWIiOiIxMjM....\n        "
    tokenAuth:
      type: http
      scheme: bearer
externalDocs:
  url: https://docs.cloudtruth.com/