Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Source-bound WorkOS API key or configured machine OIDC token. OIDC webhook management requires karsa:webhooks:manage.

Path Parameters

endpointId
string
required
Minimum string length: 1

Body

application/json
name
string
Required string length: 1 - 120
url
string<uri>
Maximum string length: 2048
eventTypes
enum<string>[]
Required array length: 1 - 3 elements
Available options:
kyb.evaluation.queued,
kyb.evaluation.completed,
kyb.evaluation.failed

Response

The updated endpoint

id
string
required
Minimum string length: 1
sourceId
string
required
Minimum string length: 1
name
string
required
Minimum string length: 1
url
string<uri>
required
status
enum<string>
required
Available options:
PENDING_VERIFICATION,
ACTIVE,
DISABLED,
DELETED
eventTypes
enum<string>[]
required
Available options:
kyb.evaluation.queued,
kyb.evaluation.completed,
kyb.evaluation.failed
verifiedAt
string<date-time> | null
required
verificationFailure
string | null
required
signingKeys
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required