Sonar Webhooks API

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

Operations 4

GET /v1/webhooks Get Webhooks #
POST /v1/webhooks Create Webhook #
PUT /v1/webhooks/:id Update Webhook #
DELETE /v1/webhooks/:id Delete Webhook #

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/sendsonar-com:sendsonar-com-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.

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

OpenAPI Specification

sendsonar-com-webhooks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Settings Webhooks API
  version: '1.0'
servers:
- url: https://www.sendsonar.com/api
security:
- sec0: []
  sec1: []
tags:
- name: Webhooks
paths:
  /v1/webhooks:
    get:
      summary: Get Webhooks
      description: ''
      operationId: get-webhook
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '[{"id":2,"active":true,"settings":{"new_assigned_message":"true","new_unassigned_message":"true"},"url":"https://kittenland.com","http_method":"POST","payload":"","name":"Meow Webhook1","created_at":"2015-07-25T20:19:09.213-07:00","updated_at":"2015-08-08T16:46:20.364-07:00"}, {"id":3,"active":true,"settings":{"new_assigned_message":"true","new_unassigned_message":"true"},"url":"https://woofland.com","http_method":"POST","payload":"","name":"Woof Webhook1","created_at":"2015-07-25T20:19:09.213-07:00","updated_at":"2015-08-08T16:46:20.364-07:00"}]'
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      example: 2
                      default: 0
                    active:
                      type: boolean
                      example: true
                      default: true
                    settings:
                      type: object
                      properties:
                        new_assigned_message:
                          type: string
                          example: 'true'
                        new_unassigned_message:
                          type: string
                          example: 'true'
                    url:
                      type: string
                      example: https://kittenland.com
                    http_method:
                      type: string
                      example: POST
                    payload:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: Meow Webhook1
                    created_at:
                      type: string
                      example: '2015-07-25T20:19:09.213-07:00'
                    updated_at:
                      type: string
                      example: '2015-08-08T16:46:20.364-07:00'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: curl
          code: "curl 'https://www.sendsonar.com/api/v1/webhooks' \\\n -X GET \\\n -H 'X-Token:XXXXXXXXXXXXXXXXXXXXX' \\\n -H \"Content-Type: application/json\" \\"
        samples-languages:
        - curl
      tags:
      - Webhooks
    post:
      summary: Create Webhook
      description: ''
      operationId: create-webhook
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - webhook
              - active
              - settings
              - url
              - http_method
              - name
              properties:
                webhook:
                  type: string
                  description: 'Object that contains all the following, required, parameters: active, settings, url, http_method, and name'
                  format: json
                active:
                  type: boolean
                  description: Set the webhook as active or inactive
                  default: false
                settings:
                  type: string
                  description: Specifies the event, or events, for which a webhook should be triggered (see "Settings Description" section above for more detail)
                  format: json
                url:
                  type: string
                  description: The endpoint the webhook should hit
                http_method:
                  type: string
                  description: The http method the webhook should use
                name:
                  type: string
                  description: Name of the webhook
      responses:
        '201':
          description: '201'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"webhook\": {\n        \"id\": 1234,\n        \"active\": true,\n        \"settings\": {\n            \"new_unassigned_message\": \"true\",\n            \"new_assigned_message\": \"true\"\n        },\n        \"url\": \"https://endpoint.com/\",\n        \"http_method\": \"POST\",\n        \"payload\": null,\n        \"company_id\": 9876,\n        \"name\": \"sample_webhook\",\n        \"created_at\": \"2024-09-23T11:43:22.062-07:00\",\n        \"updated_at\": \"2024-09-23T11:43:22.062-07:00\",\n        \"consecutive_failure_count\": 0,\n        \"channel\": null\n    }\n}"
              schema:
                type: object
                properties:
                  webhook:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1234
                        default: 0
                      active:
                        type: boolean
                        example: true
                        default: true
                      settings:
                        type: object
                        properties:
                          new_unassigned_message:
                            type: string
                            example: 'true'
                          new_assigned_message:
                            type: string
                            example: 'true'
                      url:
                        type: string
                        example: https://endpoint.com/
                      http_method:
                        type: string
                        example: POST
                      payload: {}
                      company_id:
                        type: integer
                        example: 9876
                        default: 0
                      name:
                        type: string
                        example: sample_webhook
                      created_at:
                        type: string
                        example: '2024-09-23T11:43:22.062-07:00'
                      updated_at:
                        type: string
                        example: '2024-09-23T11:43:22.062-07:00'
                      consecutive_failure_count:
                        type: integer
                        example: 0
                        default: 0
                      channel: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n\t\"error\": \"bad request\"\n}"
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: bad request
      deprecated: false
      security: []
      x-readme:
        code-samples:
        - language: curl
          code: "curl 'https://www.sendsonar.com/api/v1/webhooks' \\\n  -X POST \\\n  -H 'X-Token:YOUR_TOKEN' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"webhook\": {\"name\": \"sample_webhook\", \"active\": \"true\", \"settings\": {\"new_unassigned_message\": \"true\",\"new_assigned_message\": \"true\"}, \"url\": \"https://endpoint.com/\", \"http_method\": \"POST\"}}'"
        samples-languages:
        - curl
      tags:
      - Webhooks
  /v1/webhooks/:id:
    put:
      summary: Update Webhook
      description: ''
      operationId: update-webhook
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - webhook
              properties:
                webhook:
                  type: string
                  description: 'Object that contains any of the following, optional, parameters: active, settings, url, http_method, and name'
                  format: json
                active:
                  type: boolean
                  description: Set the webhook as active or inactive
                  default: false
                settings:
                  type: array
                  description: When to trigger the webhook
                url:
                  type: string
                  description: The endpoint the webhook should hit
                http_method:
                  type: string
                  description: The http method the webhook should use
                name:
                  type: string
                  description: Name of the webhook
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{"id":2,"active":true,"settings":{"new_assigned_message":"true","new_unassigned_message":"true"},"url":"https://kittenland.com","http_method":"POST","payload":"","name":"Meow Webhook1","created_at":"2015-07-25T20:19:09.213-07:00","updated_at":"2015-08-08T16:46:20.364-07:00"}'
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 2
                    default: 0
                  active:
                    type: boolean
                    example: true
                    default: true
                  settings:
                    type: object
                    properties:
                      new_assigned_message:
                        type: string
                        example: 'true'
                      new_unassigned_message:
                        type: string
                        example: 'true'
                  url:
                    type: string
                    example: https://kittenland.com
                  http_method:
                    type: string
                    example: POST
                  payload:
                    type: string
                    example: ''
                  name:
                    type: string
                    example: Meow Webhook1
                  created_at:
                    type: string
                    example: '2015-07-25T20:19:09.213-07:00'
                  updated_at:
                    type: string
                    example: '2015-08-08T16:46:20.364-07:00'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: text
          code: "curl 'https://www.sendsonar.com/api/v1/webhooks/2' \\\n  -X PUT \\\n  -H 'X-Token:YOUR_TOKEN' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"webhook\": {\"name\": \"Cat\", \"active\": \"true\", \"settings\": {}, \"url\": \"http://meow.meow\", \"http_method\": \"POST\"}}'"
        samples-languages:
        - text
      tags:
      - Webhooks
    delete:
      summary: Delete Webhook
      description: ''
      operationId: delete-webhooks
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{"success": "true"}'
              schema:
                type: object
                properties:
                  success:
                    type: string
                    example: 'true'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: curl
          code: "curl 'https://www.sendsonar.com/api/v1/webhooks' \\\n -X DELETE \\\n -H 'X-Token:XXXXXXXXXXXXXXXXXXXXX' \\\n -H \"Content-Type: application/json\" \\"
        samples-languages:
        - curl
      tags:
      - Webhooks
components:
  securitySchemes:
    sec0:
      type: apiKey
      name: X-Token
      in: header
      x-default: ''
    sec1:
      type: apiKey
      name: token
      in: query
      x-default: ''
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.sendsonar.com/reference
  harvested: '2026-10-25'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.sendsonar.com/reference/addupdate-customer.md
  - https://docs.sendsonar.com/reference/append-tag-to-message.md
  - https://docs.sendsonar.com/reference/available-phone-number.md
  - https://docs.sendsonar.com/reference/close-customer.md
  - https://docs.sendsonar.com/reference/create-new-role-permission.md
  - https://docs.sendsonar.com/reference/create-new-sonar-account.md
  - https://docs.sendsonar.com/reference/create-webhook.md
  - https://docs.sendsonar.com/reference/delete-customer-properties.md
  - https://docs.sendsonar.com/reference/delete-webhooks.md
  - https://docs.sendsonar.com/reference/double-opt-in-prompt.md
  - https://docs.sendsonar.com/reference/events.md
  - https://docs.sendsonar.com/reference/follow-up-endpoint.md
  - https://docs.sendsonar.com/reference/gdpr-delete-request.md
  - https://docs.sendsonar.com/reference/gdpr-get-request.md
  - https://docs.sendsonar.com/reference/get-account-roles.md
  - https://docs.sendsonar.com/reference/get-all-users-from-account.md
  - https://docs.sendsonar.com/reference/get-conversation-by-id.md
  - https://docs.sendsonar.com/reference/get-customer.md
  - https://docs.sendsonar.com/reference/get-specific-user-by-id.md
  - https://docs.sendsonar.com/reference/get-webhook.md
  - https://docs.sendsonar.com/reference/invite-new-user.md
  - https://docs.sendsonar.com/reference/personalized-campaign.md
  - https://docs.sendsonar.com/reference/remove-follow-up.md
  - https://docs.sendsonar.com/reference/send-campaign.md
  - https://docs.sendsonar.com/reference/send-message.md
  - https://docs.sendsonar.com/reference/unassign-agent.md
  - https://docs.sendsonar.com/reference/update-webhook.md
  merge:
    pages: 27
    deduped: 52
    conflicts_kept_first: 0