SPOTIO

SPOTIO Webhooks API

The controller is responsible for handling webhooks related operations. It provides methods for retrieving available webhook scopes, getting all webhooks for the current company, creating a new webhook, updating an existing webhook and deleting a webhook by its ID. More information about webhooks and how it works can be found in the section 'Group Web hooks'

GitHub OpenAPI

Operations 5

GET /api/Webhooks/scopes Retrieve all available webhook scopes
GET /api/Webhooks Get all webhooks for the current company
POST /api/Webhooks Create a new webhook
PUT /api/Webhooks/{id} Update an existing webhook
DELETE /api/Webhooks/{id} Delete a webhook by its ID

Documentation

📖
Documentation
https://developer.spotio2.com/docs/spotio2/a4cpj8d1knctg-quickstart-for-the-spotio-api
📖
APIReference
https://developer.spotio2.com/docs/spotio2/c977e70019695-spotio-2-0

Specifications

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

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/spotio/refs/heads/main/overlays/spotio-webhooks-overlay.yaml

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/spotio-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

spotio-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: v1
  title: Spotio 2.0 Webhooks API
  description: "\nThe controller is responsible for handling webhooks related operations. \nIt provides methods for retrieving available webhook scopes, getting all webhooks for the current company, creating a new webhook, updating an existing webhook and deleting a webhook by its ID.\nMore information about webhooks and how it works can be found in the section 'Group Web hooks'\n"
  contact:
    name: Contact us
    url: https://spotio.com/contact/
    email: support@spotio.com
servers:
- url: https://api.spotio2.com
  description: Production
- url: https://app-test.spotio2.com
  description: Test
security:
- Bearer: []
tags:
- name: Webhooks
  description: "\nThe controller is responsible for handling webhooks related operations. \nIt provides methods for retrieving available webhook scopes, getting all webhooks for the current company, creating a new webhook, updating an existing webhook and deleting a webhook by its ID.\nMore information about webhooks and how it works can be found in the section 'Group Web hooks'\n"
paths:
  /api/Webhooks/scopes:
    get:
      tags:
      - Webhooks
      summary: Retrieve all available webhook scopes
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  type: string
            application/json:
              schema:
                type: array
                items:
                  type: string
            text/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - Bearer: []
      servers:
      - url: https://api.spotio2.com
        description: Production
      - url: https://app-test.spotio2.com
        description: Test
  /api/Webhooks:
    get:
      tags:
      - Webhooks
      summary: Get all webhooks for the current company
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.WebhooksDto'
            application/json:
              schema:
                $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.WebhooksDto'
            text/json:
              schema:
                $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.WebhooksDto'
      security:
      - Bearer: []
      servers:
      - url: https://api.spotio2.com
        description: Production
      - url: https://app-test.spotio2.com
        description: Test
    post:
      tags:
      - Webhooks
      summary: Create a new webhook
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.NewWebhookDto'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.NewWebhookDto'
          application/json:
            schema:
              $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.NewWebhookDto'
          text/json:
            schema:
              $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.NewWebhookDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.NewWebhookDto'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.WebhookEndpointDto'
            application/json:
              schema:
                $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.WebhookEndpointDto'
            text/json:
              schema:
                $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.WebhookEndpointDto'
      security:
      - Bearer: []
      servers:
      - url: https://api.spotio2.com
        description: Production
      - url: https://app-test.spotio2.com
        description: Test
  /api/Webhooks/{id}:
    put:
      tags:
      - Webhooks
      summary: Update an existing webhook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.UpdateWebhookDto'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.UpdateWebhookDto'
          application/json:
            schema:
              $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.UpdateWebhookDto'
          text/json:
            schema:
              $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.UpdateWebhookDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.UpdateWebhookDto'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.WebhookEndpointDto'
            application/json:
              schema:
                $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.WebhookEndpointDto'
            text/json:
              schema:
                $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.WebhookEndpointDto'
      security:
      - Bearer: []
      servers:
      - url: https://api.spotio2.com
        description: Production
      - url: https://app-test.spotio2.com
        description: Test
    delete:
      tags:
      - Webhooks
      summary: Delete a webhook by its ID
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
      security:
      - Bearer: []
      servers:
      - url: https://api.spotio2.com
        description: Production
      - url: https://app-test.spotio2.com
        description: Test
components:
  schemas:
    Spotio.Frontend.ViewModel.Webhooks.WebhooksDto:
      type: object
      description: A DTO containing webhook information
      additionalProperties: false
      properties:
        secret:
          type:
          - string
          - 'null'
          description: The webhook secret
        endpoints:
          type:
          - array
          - 'null'
          description: A list of webhook endpoints
          items:
            $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.WebhookEndpointDto'
    Spotio.Frontend.ViewModel.Webhooks.CustomHeaderDto:
      type: object
      description: A DTO containing custom header information for a webhook
      additionalProperties: false
      properties:
        name:
          type:
          - string
          - 'null'
          description: The name of the custom header
        value:
          type:
          - string
          - 'null'
          description: The value of the custom header
    Spotio.Frontend.ViewModel.Webhooks.NewWebhookDto:
      type: object
      description: A DTO for creating a new webhook
      additionalProperties: false
      properties:
        callback:
          type:
          - string
          - 'null'
          description: The callback URL for the new webhook
        scopes:
          type:
          - array
          - 'null'
          description: A list of webhook scopes for the new webhook
          items:
            type: string
        customHeaders:
          type:
          - array
          - 'null'
          description: An optional list of custom headers for the new webhook
          items:
            $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.CustomHeaderDto'
    Spotio.Frontend.ViewModel.Webhooks.WebhookEndpointDto:
      type: object
      description: A DTO containing webhook endpoint information
      additionalProperties: false
      properties:
        id:
          type:
          - string
          - 'null'
          description: The unique identifier of the webhook endpoint
        callback:
          type:
          - string
          - 'null'
          description: The callback URL for the webhook
        scopes:
          type:
          - array
          - 'null'
          description: A list of webhook scopes
          items:
            type: string
        active:
          type: boolean
          description: The active status of the webhook
        customHeaders:
          type:
          - array
          - 'null'
          description: A list of custom headers for the webhook
          items:
            $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.CustomHeaderDto'
    Spotio.Frontend.ViewModel.Webhooks.UpdateWebhookDto:
      type: object
      description: A DTO for updating an existing webhook
      additionalProperties: false
      properties:
        callback:
          type:
          - string
          - 'null'
          description: The updated callback URL for the webhook
        scopes:
          type:
          - array
          - 'null'
          description: The updated list of webhook scopes
          items:
            type: string
        active:
          type: boolean
          description: The updated active status of the webhook
        customHeaders:
          type:
          - array
          - 'null'
          description: An optional updated list of custom headers for the webhook
          items:
            $ref: '#/components/schemas/Spotio.Frontend.ViewModel.Webhooks.CustomHeaderDto'
  securitySchemes:
    Bearer:
      type: apiKey
      description: 'Enter the Bearer Authorization string as following: `Bearer Generated-JWT-Token`'
      name: Authorization
      in: header