Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

A Rafflesia API key, sent as Authorization: Bearer <key>.

Path Parameters

endpoint_id
string
required
Pattern: ^whep_[0-9a-f]{24}$

Body

application/json
description
string
Maximum string length: 500
enabled_events
string[]
Maximum array length: 20
metadata
object
status
enum<string>
Available options:
enabled,
disabled
url
string<uri>
Maximum string length: 2048

Response

OK

ok
boolean
required

Whether the operation succeeded.

provenance
object
required

Execution provenance.

warnings
object[] | null
required

Non-fatal warnings.

$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/ExecutionEnvelopeWebhookEndpoint.json"

data
object

Operation result data. Absent when the operation did not succeed.

error
object

Structured execution error information.

evidence
object

Mechanical evidence summary for agent inspection and chaining.