Webhooks | SalesOS Docs

Get all webhooks for current user

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

isActiveboolean

curl -X GET "https://www.salesos.org/api/api/webhooks?isActive=true" \
  -H "Authorization: Bearer <token>"

Create a new webhook

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

nameRequiredstring

Webhook name

descriptionstring

Webhook description

urlRequiredstring

Webhook endpoint URL

eventsRequiredarray<string>

Events to subscribe to

headersobject

Custom headers to send with requests

isActiveboolean

Is webhook active

Default: true

retryAttemptsnumber

Number of retry attempts on failure

Default: 3

retryDelaySecondsnumber

Delay between retries in seconds

Default: 60

curl -X POST "https://www.salesos.org/api/api/webhooks" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "url": "string",
    "events": [
      "lead.created",
      "opportunity.won"
    ],
    "headers": {},
    "isActive": true,
    "retryAttempts": 3,
    "retryDelaySeconds": 60
  }'

Get list of available webhook events

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://www.salesos.org/api/api/webhooks/events" \
  -H "Authorization: Bearer <token>"

Get webhook statistics

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://www.salesos.org/api/api/webhooks/stats" \
  -H "Authorization: Bearer <token>"

Get a webhook by ID

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X GET "https://www.salesos.org/api/api/webhooks/<string>" \
  -H "Authorization: Bearer <token>"

Update a webhook

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

namestring

Webhook name

descriptionstring

Webhook description

urlstring

Webhook endpoint URL

eventsarray<string>

Events to subscribe to

headersobject

Custom headers to send with requests

isActiveboolean

Is webhook active

retryAttemptsnumber

Number of retry attempts on failure

retryDelaySecondsnumber

Delay between retries in seconds

Path Parameters

idRequiredstring

curl -X PATCH "https://www.salesos.org/api/api/webhooks/<string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "url": "string",
    "events": [
      "string"
    ],
    "headers": {},
    "isActive": true,
    "retryAttempts": 0,
    "retryDelaySeconds": 0
  }'

Delete a webhook

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X DELETE "https://www.salesos.org/api/api/webhooks/<string>" \
  -H "Authorization: Bearer <token>"

Regenerate webhook secret

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X POST "https://www.salesos.org/api/api/webhooks/<string>/regenerate-secret" \
  -H "Authorization: Bearer <token>"

Send a test webhook delivery

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X POST "https://www.salesos.org/api/api/webhooks/<string>/test" \
  -H "Authorization: Bearer <token>"

Get webhook delivery logs

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

Query Parameters

successboolean

eventstring

pagenumber

limitnumber

curl -X GET "https://www.salesos.org/api/api/webhooks/<string>/deliveries?success=true&event=%3Cstring%3E&page=0&limit=0" \
  -H "Authorization: Bearer <token>"