Skip to main content
POST
/
v1
/
webhooks
cURL
curl --request POST \
  --url https://client-api.salesfinity.co/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "events": [],
  "dispositions": [
    123
  ]
}
'
{}
Creates a new webhook subscription. Webhooks allow you to receive real-time HTTP POST notifications when specific events occur in your account.

​
Request Body

FieldTypeRequiredDescription
namestringYesA descriptive name for the webhook
urlstringYesThe URL to receive webhook POST requests (must be a valid URL)
eventsstring[]YesArray of event types to subscribe to
dispositionsnumber[]NoFilter CALL_LOGGED events by disposition IDs. If provided, only calls with matching dispositions will trigger the webhook.

​
Available Events

EventDescription
CALL_LOGGEDTriggered when a user logs a call, capturing relevant call details
CONTACT_SNOOZEDTriggered when a contact is snoozed, capturing the contact and snooze details

​
Example Request

{
  "name": "CRM Call Sync",
  "url": "https://example.com/webhooks/salesfinity",
  "events": ["CALL_LOGGED"],
  "dispositions": [1, 4]
}

​
Response (201)

Returns the created webhook object. 
{
  "_id": "507f1f77bcf86cd799439011",
  "name": "CRM Call Sync",
  "url": "https://example.com/webhooks/salesfinity",
  "events": ["CALL_LOGGED"],
  "dispositions": [1, 4],
  "status": "active",
  "createdAt": "2024-01-15T10:00:00.000Z",
  "updatedAt": "2024-01-15T10:00:00.000Z"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required

A descriptive name for the webhook

​
url
string<uri>
required

The URL to receive webhook POST requests

​
events
enum<string>[]
required

Event types to subscribe to

Available options:
CALL_LOGGED,
CONTACT_SNOOZED
​
dispositions
integer[]

Filter CALL_LOGGED events by disposition IDs

Response

201 - application/json

Webhook created successfully

The response is of type object.