Securitize

Securitize Webhooks API

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

GitHub OpenAPI

Documentation

📖
Documentation
https://domain-api-docs.securitize.io/
📖
APIReference
https://public-api.sandbox.securitize.io/docs/
📖
GettingStarted
https://domain-api-docs.securitize.io/api/api-specs
📖
Authentication
https://domain-api-docs.securitize.io/api/authentication

Specifications

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

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/securitize/refs/heads/main/llms/securitize-domain-api-llms.txt
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/securitize/refs/heads/main/errors/securitize-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/securitize/refs/heads/main/data-model/securitize-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/securitize/refs/heads/main/asyncapi/securitize-webhooks.yml

OpenAPI Specification

securitize-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 3.0.0
  title: Securitize Domains Webhooks API
security:
- ApiKeyAuth: []
tags:
- name: Webhooks
paths:
  /v1/webhooks/events:
    get:
      operationId: EventsController_getEvents
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookEventDto'
      tags:
      - Webhooks
  /v1/webhooks/subscriptions:
    get:
      operationId: SubscriptionsController_getSubscriptions
      parameters:
      - name: domainId
        required: false
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookSubscriptionResponseDto'
      tags:
      - Webhooks
    post:
      operationId: SubscriptionsController_createSubscription
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookSubscriptionBodyDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscriptionResponseDto'
      tags:
      - Webhooks
  /v1/webhooks/subscriptions/{subscriptionId}:
    get:
      operationId: SubscriptionsController_getSubscription
      parameters:
      - name: subscriptionId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscriptionResponseDto'
      tags:
      - Webhooks
    patch:
      operationId: SubscriptionsController_updateSubscription
      parameters:
      - name: subscriptionId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookSubscriptionBodyDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscriptionResponseDto'
      tags:
      - Webhooks
    delete:
      operationId: SubscriptionsController_deleteSubscription
      parameters:
      - name: subscriptionId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - Webhooks
  /v1/webhooks/settings/signature:
    post:
      operationId: SettingsController_createSignature
      parameters: []
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSignatureResponseDto'
      tags:
      - Webhooks
components:
  schemas:
    WebhookSignatureResponseDto:
      type: object
      properties:
        publicKey:
          type: string
      required:
      - publicKey
    CreateWebhookSubscriptionBodyDto:
      type: object
      properties:
        domainId:
          type: string
        eventType:
          type: string
        payloadUrl:
          type: string
        isActive:
          type: boolean
          default: true
      required:
      - domainId
      - eventType
      - payloadUrl
    WebhookSubscriptionResponseDto:
      type: object
      properties:
        id:
          type: string
        domainId:
          type: string
        eventType:
          type: string
        nonce:
          type: number
        payloadUrl:
          type: string
        isActive:
          type: boolean
      required:
      - id
      - domainId
      - eventType
      - nonce
      - payloadUrl
      - isActive
    UpdateWebhookSubscriptionBodyDto:
      type: object
      properties:
        payloadUrl:
          type: string
        isActive:
          type: boolean
    WebhookEventDto:
      type: object
      properties:
        eventType:
          type: string
        properties:
          type: array
          items:
            type: string
      required:
      - eventType
      - properties
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API Key Format as "apiKey <key_id>:<key_secret>"