Deliver an event to a Webhook
The URL an external sender calls. Present the Webhook's secret as Authorization: Bearer chrm_hook_… or ?key=chrm_hook_…. The body is the target op's input, validated against its declared input schema: a JSON object, or a multipart/form-data or application/x-www-form-urlencoded form whose text fields become the input, each converted to the type the schema declares. File parts are dropped and listed in the delivery record. The response is the op's own result envelope, validated against its output schema. Tagged x-charming-trigger: webhook for the handler.
Request
- Base URL: https://charm.ing
- URL: https://charm.ing/api/v1/hooks/{webhookId}
- Auth: none required
Request body
The target op's input. Its shape is the op's declared input schema, returned as target.input_schema when the Webhook was created, so it cannot be closed here.
Response
The op's result envelope, { ok: true, value }.
Changes
No recorded changes to this operation across all 1 revision of this API.