Webhook Endpoints

List webhook endpoints

Lists webhook endpoints in the current workspace, including subscribed events, signing state, status, and retry policy.

GEThttps://api.unifyport.ai/v1/webhook-endpoints

Before you call

Use a server-side X-Api-Key for the workspace that owns the resource. Replace every placeholder before running a sample.

Request parameters

Headers

X-Api-Key

stringrequired

Workspace API key. The workspace is resolved from this header.

Request body

This endpoint does not require a JSON request body.

Understand the result

A successful configuration request does not prove event delivery. Trigger a relevant event and verify receipt, signature and acknowledgement at your receiver.

Response 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": [
    {
      "id": "we_example",
      "url": "https://example.com/webhook",
      "status": "active",
      "subscribed_events": [
        "message.received"
      ],
      "signing_enabled": true,
      "retry_policy": {
        "max_attempts": 3
      }
    }
  ]
}

Response body

id

string

Webhook endpoint identifier (we_...).

url

string

Absolute HTTP(S) URL that receives webhook deliveries; HTTPS is recommended for production.

format: uri

status

string

Endpoint status: active or inactive.

enum: active, inactive

subscribed_events[]

string[]

Public standard event types delivered to the endpoint; ["*"] means all public events and does not include provider.raw_event.

signing_enabled

boolean

true when a signing secret is set and deliveries are signed.

retry_policy

object

Retry settings returned by the API. max_attempts counts retries after the initial delivery, defaults to 3, and is limited to 0-5.

max_attempts

integer

Configured retries after the initial delivery, from 0 to 5.

Responses

200

200 OK

Request succeeded. See the example response body.

401

Unauthorized

The X-Api-Key header is missing or invalid.

500

Internal Server Error

The service encountered an unexpected error.

If the request fails

Inspect HTTP status and error.code/numeric_code, and keep request_id for diagnosis. Correct invalid parameters, complete required authorization or check runtime state as appropriate. Confirm the outcome before retrying a send or another write. Error reference

invalid_request · 10000 · 400: Check required fields, formats and channel conditions, then correct the request.
invalid_api_key · 11001 · 401: Check X-Api-Key and whether the workspace is active.