v1

latestOpenAPI 3.1.02026-07-14159142161.9 KB

outgoing webhooks (usersService)

Create a New Outgoing Webhook

Creates a new outgoing webhook with specified details.

post/company/v1/webhooks

Request body

urlstring uri required

Should be unique per portal

activeboolean

Example request

{
  "url": "https://my-webhook-domain/?param=uspacy",
  "active": true,
  "events": [
    {
      "service": "crm",
      "type": "entity_crm",
      "table_name": "leads"
    }
  ]
}

Response

idinteger

urlstring uri

Should be unique per portal

activeboolean

user_idinteger

confirmedboolean

created_atinteger

updated_atinteger

Example response

{
  "id": 16,
  "url": "https://my-webhook-domain/?param=uspacy",
  "active": true,
  "user_id": 1,
  "confirmed": true,
  "created_at": 1732739313,
  "updated_at": 1732739313,
  "events": [
    {
      "service": "crm",
      "type": "entity_crm",
      "table_name": "leads"
    }
  ]
}