Sonar Events API

openapi: 3.2.0
info:
  title: Settings Events API
  version: '1.0'
servers:
- url: https://www.sendsonar.com/api
security:
- sec0: []
  sec1: []
tags:
- name: Events
paths:
  /v1/events:
    post:
      summary: Events
      description: ''
      operationId: events
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - event_type
              properties:
                email:
                  type: string
                  description: The email of your customer
                  default: test@sendsonar.com
                phone_number:
                  type: string
                  description: The phone number of your customer
                  default: '+13105551234'
                event_type:
                  type: string
                  description: The event type. Must be a valid type (currently only "conversion". Custom types will be supported in the future.)
                  default: conversion
                event_properties:
                  type: object
                  description: State the name of your conversion and the value
                  properties: {}
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '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/events' \\\n  -X POST \\\n  -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"phone_number\": \"+13105551234\", \"event_type\": \"conversion\", \"event_properties\": {\"name\": \"Online Store Purchase\", \"value\": 25.00}}'\n"
          name: Example via Phone Number
        - language: curl
          code: "curl 'https://www.sendsonar.com/api/v1/events' \\\n  -X POST \\\n  -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"email\": \"matt@sendsonar.com\", \"type\": \"conversion\", \"event_properties\": {\"name\": \"Online Store Purchase\", \"value\": 25.00}}'"
          name: Example via Email
        samples-languages:
        - curl
      tags:
      - Events
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