Webhook Endpoints

Get webhook endpoint

Returns one webhook endpoint configuration.

GEThttps://api.unifyport.ai/v1/webhook-endpoints/{endpoint_id}

Supported channels

all

Before you call

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

Prepare your parameters

account_id: Use data.id from account creation or an account query. Account identifiers belong to the workspace selected by X-Api-Key. Get account

Request parameters

Headers

X-Api-Key

stringrequired

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

Path parameters

endpoint_id

stringrequired

Identifier used in the webhook endpoints route.

Query parameters

account_id

string

Optional public account ID, e.g. acc_example. Must not be empty, whitespace-only, or repeated. Use exactly account_id; case variants return 400 invalid_request, not omission. Listing without it returns only workspace endpoints; with it, only independent account configurations (data=[] if none, without inherited workspace configurations). Get, deactivate, and delete only validate existing ownership; a mismatch returns 400 invalid_request. An explicit account outside the workspace or not found returns 404 account_not_found (20020).

minLength: 1 · pattern: \S

Request body

This endpoint does not require a JSON request body.

Understand the result

Read the endpoint’s scope, status, subscriptions, signing_enabled and retry policy. A successful query confirms configuration only; it does not prove event delivery.

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_...).

account_id

string

Public account ID for an independent account endpoint; omitted for workspace endpoints, never null.

minLength: 1

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.

400

Bad Request

The request body, path, or parameters are invalid.

401

Unauthorized

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

404

Not Found

The requested resource was not found. Check error.code and the current operation.

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.
missing_api_key · 11000 · 401: Check X-Api-Key and whether the workspace is active.
invalid_api_key · 11001 · 401: Check X-Api-Key and whether the workspace is active.