Sign in
Hook

Trigger manual hook

Invoke the hook with custom payload. The payload will be added to the standard invocation event hook request and sent to the hook. The hook response is returned in the invocation response payload.

<Callout type="warn"> Values for standard json hook response attributes (`request_id`, `action`, ...) will NOT be overwritten. </Callout> <Callout type="warn"> Attribute `timeout_s` in hook `config` for this endpoint `POST /v1/hooks/{id}/invoke` will be overwritten by default value of 30. </Callout>
post/api/v1/hooks/{hookID}/invoke

Path parameters

hookIDinteger required

A unique integer value identifying this hook.

Request body

object required

Object with properties to be merged into the invocation payload.

Example request

{
  "SAP_ID": "1234",
  "DB_COLUMN": "SAP"
}

Response

OK

object required

Hook response merged with invocation response payload.

Changes

No recorded changes to this endpoint across all 1 revision of this API.