Deliver a Payload of Data to a Custom Webhook for Procesing

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint to send data to a pre-configured custom webhook destination.

This relies on setting up an Origami Webhook Handler in advance to accept the webhook name and process payload of the request.

The name route parameter corresponds to the webhook's identifier, as defined by the "Name" field in the response from /api/Webhook/GetHandlers.

Requirements:

  • The webhook must be configured and active prior to use. Configuration is handled by the Services team.
  • The Request schema (body) must adhere to the webhook's expected format.
  • The Response schema (body) will vary for each webhook handler.
  • Samples of the request and response schemas can be requested using the Webhook/HandlerName/GetSample endpoint.
Path Params
string
required

This is the the name of the Webhook Handler as it is configured in Origami.

Body Params
json
required

This is a json object contain the key value pairs required by the Webhook's schema.

Responses
200

OK

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json