Skip to main content
POST
/
v1
/
operational-webhook
/
endpoint
TypeScript SDK
import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// Create operational webhook endpoint
const endpoint = await solifyn.webhookEndpoint.create({
  url: 'https://example.com/operational-webhook',
  description: 'Production operational monitoring endpoint',
  filterTypes: ['message.attempt.failing', 'message.attempt.exhausted']
});
console.log('Operational endpoint created:', endpoint);
{
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "url": "https://example.com/webhook/",
  "description": "Production monitoring endpoint",
  "disabled": false,
  "filterTypes": [
    "message.attempt.failing"
  ],
  "throttleRate": 0,
  "createdAt": "2026-05-30T14:11:29.071Z",
  "updatedAt": "2026-05-30T14:11:29.071Z",
  "metadata": {
    "environment": "production"
  },
  "uid": "monitoring-prod-endpoint",
  "secret": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"
}

Body

application/json
​
url
string
required

The URL to send webhook events to.

Maximum string length: 65536
Example:

"https://example.com/webhook/"

​
description
string

Optional description for the endpoint.

Example:

"Production monitoring endpoint"

​
disabled
boolean
default:false

Whether the endpoint is disabled.

Example:

false

​
filterTypes
string[]

The operational event types this endpoint will receive.

Example:
[
  "message.attempt.failing",
  "message.attempt.exhausted"
]
​
metadata
object

Metadata key-value pairs associated with the endpoint.

Example:
{ "environment": "production" }
​
secret
string

Optional custom endpoint signing secret (base64 encoded random bytes optionally prefixed with whsec_). If not set, the server will generate one.

Example:

"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"

​
throttleRate
number

Maximum messages per second to send to this endpoint (outgoing messages will be throttled to this rate).

Example:

5

​
uid
string

Optional unique user-defined identifier for the endpoint.

Example:

"monitoring-prod-endpoint"

Response

201 - application/json
​
id
string
required
Example:

"ep_1srOrx2ZWZBpBUvZwXKQmoEYga2"

​
url
string
required
Example:

"https://example.com/webhook/"

​
description
string
required
Example:

"Production monitoring endpoint"

​
disabled
boolean
required
Example:

false

​
filterTypes
string[]
required
Example:
["message.attempt.failing"]
​
throttleRate
number
required
Example:

0

​
createdAt
string<date-time>
required
Example:

"2026-05-30T14:11:29.071Z"

​
updatedAt
string<date-time>
required
Example:

"2026-05-30T14:11:29.071Z"

​
metadata
object
Example:
{ "environment": "production" }
​
uid
object
Example:

"monitoring-prod-endpoint"

​
secret
string

The endpoint's raw secret (only returned on POST creation).

Example:

"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"