Skip to main content
POST
Register a webhook endpoint

Authorizations

x-api-key
string
header
required

Partner API key. Also accepted as Authorization: Bearer <key>.

Body

application/json
endpoint
string<uri>
required

HTTPS URL TruEnroll will POST events to.

apiKey
string
required

A secret you choose (at least 20 characters). TruEnroll sends it back as the x-api-key header on every delivery, so you can verify each request is genuine.

Minimum string length: 20
audience
enum<string>

Audience for the endpoint. On the Partner API this defaults to partner, so the endpoint receives Partner API case events. You normally don't need to set it.

Available options:
partner,
internal
description
string

Optional human-readable label for the endpoint.

Response

Webhook endpoint registered.

success
boolean
required
Example:

true

message
string
required
meta
object
required

Optional metadata (e.g. pagination). Empty object when not applicable.

data
object
required