Callable Recipes - New call for recipe trigger
This trigger creates a job whenever it is called, in real-time. It can be called from another recipe or from another system as a API Platform REST endpoint.
API Platform must be enabled for your account before a callable recipe can be exposed as a REST endpoint. Check the Pricing and Plans page to find out more.
New call for recipe trigger
Input fields
| Input field | Description |
|---|---|
| Name | Give this callable recipe trigger a name that describes its function. |
| Input schema | If this recipe expects JSON, use this to describe the expected JSON structure. |
| Response schema | If this recipe responds with JSON data, use this to describe the JSON structure. |
| Request type | Select the request data format. Defaults to JSON request body if left blank. |
| Response type | Select the response data format. Defaults to JSON response if left blank. |
Output fields
| Input field | Description | |
|---|---|---|
|
Context Only if this recipe is used as a REST endpoint |
Calling job ID | ID of the job in the parent recipe that made the call. |
| Calling recipe ID | ID of the parent recipe that made the call. | |
| Calling IP address |
Only available if called through the API Platform. IP address of the client calling this recipe as a REST endpoint. |
|
| Access profile |
Only available if called through the API Platform. Contains ID, name and authentication method of the access profile used to perform the request. |
|
| API client |
Only available if called through the API Platform. Contains API client ID and API client name values to perform the request. |
|
| JWT claims |
Only available if called through the API Platform using a JWT token. Contains Audience, JWT ID, Issuer, and Expiration Time, Not before and Issued At values of the JWT used to authenticate the request. |
|
| Request only if request type is Raw request body |
Content type |
Only available if called through the API Platform.Content-Type header value from the incoming request.
|
| Request body (raw) |
Only available if called through the API Platform. Full raw request body. |
|
| Recipe input only if request type is Raw request body |
This output object will contain all the fields defined in Input schema. | |