Skip to main content
GET
/
v1
/
webhooks
/
{id}
/
logs
cURL
curl --request GET \
  --url https://client-api.salesfinity.co/v1/webhooks/{id}/logs \
  --header 'x-api-key: <api-key>'
{}
Retrieves delivery logs for a specific webhook. Use this endpoint to monitor webhook delivery status, debug failures, and inspect payloads.

​
Path Parameters

  • id (required, string): Webhook ID

​
Query Parameters

  • limit (optional, number): Number of items per page (default: 10, max: 100)
  • page (optional, number): The current page number to retrieve (default: 1)
  • sort (optional, string): Sort field with optional - prefix for descending order (default: -createdAt)

​
Response

Returns a paginated list of webhook log entries. 
{
  "data": [
    {
      "_id": "507f1f77bcf86cd799439055",
      "event": "CALL_LOGGED",
      "status": "success",
      "request": {
        "body": {
          "event": "CALL_LOGGED",
          "payload": {
            "call_id": "call_abc123",
            "outcome": "answered",
            "duration": 180
          }
        }
      },
      "response": {
        "code": 200,
        "body": { "received": true }
      },
      "responseTime": 245,
      "createdAt": "2024-01-15T14:33:00.000Z"
    }
  ],
  "pagination": {
    "total": 50,
    "page": 1,
    "limit": 10,
    "pages": 5
  }
}

​
Response Fields

FieldTypeDescription
_idstringLog entry ID
eventstringThe event type that triggered this delivery
statusstringDelivery status (success or failed)
requestobjectThe request payload sent to the webhook URL
responseobjectThe response received (includes code and body)
responseTimenumberResponse time in milliseconds
createdAtdateWhen the delivery was attempted

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Webhook ID

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer

Items per page

Required range: 1 <= x <= 100
​
sort
string

Sort field(s). Prefix with - for descending

Response

200 - application/json

Webhook logs retrieved successfully

The response is of type object.