Get Webhook Events - Salesfinity API Docs

cURL

curl --request GET \
  --url https://client-api.salesfinity.co/v1/webhooks/events \
  --header 'x-api-key: <api-key>'

import requests

url = "https://client-api.salesfinity.co/v1/webhooks/events"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://client-api.salesfinity.co/v1/webhooks/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client-api.salesfinity.co/v1/webhooks/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://client-api.salesfinity.co/v1/webhooks/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://client-api.salesfinity.co/v1/webhooks/events")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v1/webhooks/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "event": "<string>",
    "description": "<string>"
  }
]

GET

webhooks

events

cURL

curl --request GET \
  --url https://client-api.salesfinity.co/v1/webhooks/events \
  --header 'x-api-key: <api-key>'

import requests

url = "https://client-api.salesfinity.co/v1/webhooks/events"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://client-api.salesfinity.co/v1/webhooks/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client-api.salesfinity.co/v1/webhooks/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://client-api.salesfinity.co/v1/webhooks/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://client-api.salesfinity.co/v1/webhooks/events")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v1/webhooks/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "event": "<string>",
    "description": "<string>"
  }
]

Returns a list of all available webhook event types and their descriptions. Use this endpoint to discover which events you can subscribe to when creating or updating a webhook.

Response

Returns an array of event objects.

[
  {
    "event": "CALL_LOGGED",
    "description": "Triggered when a user logs a call, capturing relevant call details."
  },
  {
    "event": "CONTACT_SNOOZED",
    "description": "Triggered when a contact is snoozed, capturing the contact and snooze details."
  }
]

Webhook delivery format

When an event fires, Salesfinity sends an HTTP POST to your configured webhook URL with a JSON body of the shape { "event": <EVENT>, "payload": <data> }.

`CALL_LOGGED` payload

{
  "event": "CALL_LOGGED",
  "payload": {
    "_id": "6a3130af1ff24e60da9d1c34",
    "call_id": "call_abc123",
    "outcome": "answered",
    "direction": "outbound",
    "duration": 180,
    "to": "+1234567890",
    "from": "+1987654321",
    "disposition": { "internal_id": 1, "external_name": "Meeting Set" },
    "contact": { "first_name": "John", "last_name": "Doe", "company": "Acme Corp" },
    "contact_list": "6a312e171ff24e60da9c4a52",
    "contact_list_item": "6a312e171ff24e60da9c4973",
    "source": {
      "type": "csv",
      "id": "6a312e181ff24e60da9c5048",
      "name": "Coordinated Solutions (Month Campaign).csv"
    },
    "user": { "_id": "69e792fd2b95b13306e936ab", "first_name": "Jane", "last_name": "Smith", "email": "[email protected]" }
  }
}

contact_list is the dialing-queue list id (ContactList._id) — an internal id that changes each time a list is imported for dialing. source identifies the original source list: for CSV lists, source.id is the CSV list id you see in Get All Lists (/v1/contact-lists/csv), and source.name is its name. For non-CSV lists, source.id/source.name are null and only source.type (e.g. hubspot) is provided. Use source.id — not contact_list — to match a call back to the list you dialed.

You can filter CALL_LOGGED deliveries by disposition when creating the webhook (see Create Webhook).

Authorizations

x-api-key

string

header

required

Response

200 - application/json

Webhook events retrieved successfully

event

string

description

string

Get All Webhooks Get Webhook by ID

​Response

​Webhook delivery format

​CALL_LOGGED payload

Authorizations

Response

Response

Webhook delivery format

`CALL_LOGGED` payload