Kinde Webhooks API

The Webhooks API from Kinde — 4 operation(s) for webhooks.

Documentation

Specifications

Other Resources

OpenAPI Specification

kinde-so-webhooks-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Kinde Management API Keys Webhooks API
  version: '1'
  description: The Kinde Management API programmatically manages a Kinde business - users, organizations, roles, permissions, feature flags, applications, connections, APIs and scopes, subscribers, properties, webhooks, and billing. Base URL is subdomain-scoped to your business (https://{subdomain}.kinde.com/api/v1). Authenticated with a Bearer JWT access token obtained via the OAuth2 client_credentials flow from a machine-to-machine (M2M) application. This document is grounded in the official Kinde Management API specification (https://api-spec.kinde.com/kinde-management-api-spec.yaml).
  contact:
    name: Kinde Support Team
    email: support@kinde.com
    url: https://docs.kinde.com
  termsOfService: https://docs.kinde.com/trust-center/agreements/terms-of-service/
servers:
- url: https://{subdomain}.kinde.com
  variables:
    subdomain:
      default: your_kinde_subdomain
      description: The subdomain generated for your business on Kinde.
security:
- kindeBearerAuth: []
tags:
- name: Webhooks
paths:
  /api/v1/events/{event_id}:
    get:
      tags:
      - Webhooks
      summary: Get Event
      operationId: GetEvent
      description: "Returns an event\n\n<div>\n  <code>read:events</code>\n</div>"
      parameters:
      - name: event_id
        in: path
        required: true
        description: The event id.
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
        '403':
          description: Forbidden
        '429':
          description: Too many requests - rate limited
      security:
      - kindeBearerAuth: []
  /api/v1/event_types:
    get:
      tags:
      - Webhooks
      summary: List Event Types
      operationId: GetEventTypes
      description: "Returns a list event type definitions\n\n<div>\n  <code>read:event_types</code>\n</div>"
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
        '403':
          description: Forbidden
        '429':
          description: Too many requests - rate limited
      security:
      - kindeBearerAuth: []
  /api/v1/webhooks/{webhook_id}:
    patch:
      tags:
      - Webhooks
      summary: Update a Webhook
      operationId: UpdateWebHook
      description: "Update a webhook\n\n<div>\n  <code>update:webhooks</code>\n</div>"
      parameters:
      - name: webhook_id
        in: path
        required: true
        description: The webhook id.
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
        '403':
          description: Forbidden
        '429':
          description: Too many requests - rate limited
      security:
      - kindeBearerAuth: []
    delete:
      tags:
      - Webhooks
      summary: Delete Webhook
      operationId: DeleteWebHook
      description: "Delete webhook\n\n<div>\n  <code>delete:webhooks</code>\n</div>"
      parameters:
      - name: webhook_id
        in: path
        required: true
        description: The webhook id.
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
        '403':
          description: Forbidden
        '429':
          description: Too many requests - rate limited
      security:
      - kindeBearerAuth: []
  /api/v1/webhooks:
    get:
      tags:
      - Webhooks
      summary: List Webhooks
      operationId: GetWebHooks
      description: "List webhooks\n\n<div>\n  <code>read:webhooks</code>\n</div>"
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
        '403':
          description: Forbidden
        '429':
          description: Too many requests - rate limited
      security:
      - kindeBearerAuth: []
    post:
      tags:
      - Webhooks
      summary: Create a Webhook
      operationId: CreateWebHook
      description: "Create a webhook\n\n<div>\n  <code>create:webhooks</code>\n</div>"
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
        '403':
          description: Forbidden
        '429':
          description: Too many requests - rate limited
      security:
      - kindeBearerAuth: []
components:
  securitySchemes:
    kindeBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Requires an access token obtained using the OAuth2 client_credentials flow from an authorized M2M application.