Sendspark

Sendspark Webhook API

The Webhook API from Sendspark — 2 operation(s) for webhook.

GitHub OpenAPI
Business capability
Webhook & Event Subscription Management BC-4270.80

Operations 5

GET /v1/workspaces/{workspaceId}/webhooks Get Webhook list by workspace ID #
POST /v1/workspaces/{workspaceId}/webhooks Create new Webhook #
GET /v1/workspaces/{workspaceId}/webhooks/{webhookId} Get Webhook by ID #
DELETE /v1/workspaces/{workspaceId}/webhooks/{webhookId} Delete Webhook by ID #
PATCH /v1/workspaces/{workspaceId}/webhooks/{webhookId} Modify Webhook #

Documentation

📖
Authentication
https://artifacts.apis.io/sendspark/authentication/sendspark-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sendspark/openapi/sendspark-webhook-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/sendspark/asyncapi/sendspark-webhooks-asyncapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/sendspark/conventions/sendspark-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/sendspark/errors/sendspark-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/sendspark/data-model/sendspark-data-model.yml
🔗
Webhooks
https://artifacts.apis.io/sendspark/asyncapi/sendspark-webhooks-asyncapi.yml

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/sendspark:sendspark-webhook-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

sendspark-webhook-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sendspark Webhook API
  version: 1.2.0
  description: Public Sendspark API. DRAFT scaffold generated from the internal API v2 spec — endpoint selection and authentication are pending engineering review before publishing.
servers:
- url: https://api-gw.sendspark.com
  description: Production
security:
- apiKey: []
  apiSecret: []
tags:
- name: Webhook
paths:
  /v1/workspaces/{workspaceId}/webhooks:
    get:
      summary: Get Webhook list by workspace ID
      operationId: getWebhookListByWorkspaceId
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: string
      tags:
      - Webhook
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BadRequest'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResourceNotFoundOrInvalidAccess'
    post:
      summary: Create new Webhook
      operationId: postCreateWebhook
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequestPayloadSchema'
      tags:
      - Webhook
      responses:
        '200':
          description: Successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateWebhookResponseSchema'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BadRequest'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResourceNotFoundOrInvalidAccess'
  /v1/workspaces/{workspaceId}/webhooks/{webhookId}:
    get:
      summary: Get Webhook by ID
      operationId: getWebhookById
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: string
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      tags:
      - Webhook
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BadRequest'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResourceNotFoundOrInvalidAccess'
    delete:
      summary: Delete Webhook by ID
      operationId: deleteWebhookById
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: string
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      tags:
      - Webhook
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BadRequest'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResourceNotFoundOrInvalidAccess'
    patch:
      summary: Modify Webhook
      operationId: patchModifyWebhook
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: string
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyWebhookRequestPayloadSchema'
      tags:
      - Webhook
      responses:
        '200':
          description: Successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ModifyWebhookResponseSchema'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BadRequest'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResourceNotFoundOrInvalidAccess'
components:
  schemas:
    extraHeaders:
      type: array
      example:
      - Authorization
      - Content-Type
      items:
        type: string
    Model143:
      type: string
      enum:
      - video_watched
      - video_played
      - video_cta_clicked
      - video_viewed
      - video_liked
      - video_request_received
      - video_generated_dv
      - video_mp4_ready
      - video_generated_error
    Model217:
      type: string
      enum:
      - video_watched
      - video_played
      - video_cta_clicked
      - video_viewed
      - video_liked
      - video_request_received
      - video_generated_dv
      - video_mp4_ready
      - video_generated_error
    module:
      type: string
      example: global | dynamics
      enum:
      - global
      - dynamics
    ModifyWebhookRequestPayloadSchema:
      type: object
      properties:
        name:
          type: string
          example: Production Webhook
        description:
          type: string
          example: Webhook for production environment
        extraHeaders:
          $ref: '#/components/schemas/extraHeaders'
        url:
          type: string
          example: https://example.com/webhook
          x-format:
            uri: true
        module:
          $ref: '#/components/schemas/module'
        identifiers:
          $ref: '#/components/schemas/identifiers'
        events:
          $ref: '#/components/schemas/events'
        enabled:
          type: boolean
          example: true
    WebhookMetadataSchema:
      type: object
      properties:
        automation:
          $ref: '#/components/schemas/automation'
      required:
      - automation
    ResourceNotFoundOrInvalidAccess:
      type: object
      properties:
        statusCode:
          type: number
          example: 404
        error:
          type: string
          example: Not Found
        message:
          type: string
          example: Resource not found or invalid access
    CreateWebhookRequestPayloadSchema:
      type: object
      properties:
        name:
          type: string
          example: Production Webhook
        description:
          type: string
          example: Webhook for production environment
        extraHeaders:
          $ref: '#/components/schemas/extraHeaders'
        url:
          type: string
          example: https://example.com/webhook
          x-format:
            uri: true
        module:
          $ref: '#/components/schemas/module'
        identifiers:
          $ref: '#/components/schemas/identifiers'
        events:
          $ref: '#/components/schemas/WebhookVideoEventsSchema'
        metadata:
          $ref: '#/components/schemas/WebhookMetadataSchema'
      required:
      - name
      - url
      - module
    identifiers:
      type: array
      items:
        type: string
        example: sdfgh2345werty345678dfghj
    WebhookVideoEventsSchema:
      type: array
      example:
      - video_watched
      - video_played
      - video_cta_clicked
      - video_viewed
      - video_liked
      - video_request_received
      - video_generated_dv
      - video_mp4_ready
      - video_generated_error
      items:
        $ref: '#/components/schemas/Model143'
    automation:
      type: object
      properties:
        workflowId:
          type: number
        provider:
          type: string
      required:
      - provider
    events:
      type: array
      example:
      - video_watched
      - video_played
      - video_cta_clicked
      - video_viewed
      - video_liked
      - video_request_received
      - video_generated_dv
      - video_mp4_ready
      - video_generated_error
      items:
        $ref: '#/components/schemas/Model217'
    ModifyWebhookResponseSchema:
      type: object
    CreateWebhookResponseSchema:
      type: object
    BadRequest:
      type: object
      properties:
        statusCode:
          type: number
          example: 400
        code:
          type: string
          example: S400-AHVE
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: Invalid request payload input
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
    apiSecret:
      type: apiKey
      in: header
      name: x-api-secret
x-provenance:
  method: harvested
  publisher: Sendspark
  source: https://help.sendspark.com/api-reference/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)