Get Webhook Sample Payload (Request & Response)

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

This endpoint exposes the required input schema for any given Origami Webhook Handler.

When an external system sends data into Origami via a webhook handler, the sender needs to know:

  • What fields to include, what data types and formats are valid
  • What fields and response message(s) could be returned when the webhook is successfully invoked.

This endpoint answers those questions by returning a sample payload for a specific handler that shows the RequestSample and the ResponseSample

Note that the {name} path param should not contain spaces. The author of the webhook can supply any value as the name, including values that contain spaces. Almost alway a name with spaces or special characters will result in a 500 runtime error.

Path Params
string
required

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

Responses

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