ApiCallNotificationInputType

No description

type ApiCallNotificationInputType {
  callback: String
  content: String
  delay_by: String
  form_configuration_ids: [ID]
  headers: HashObject
  manually_managed: Boolean
  metadata: HashObject
  name: String
  physical_file_path: String!
  request_headers: HashObject
  request_type: String!
  to: String!
  trigger_condition: String
}

Fields

callback (String)

liquid code which can be used to process the response from the endpoint. You have access to "response" variable.

content (String)

liquid code to evaluate to whatever you want to send as a request body, for example a JSON.

delay_by (String)

liquid code which should evaluate to integer. Delays invoking the job by
specified number of minutes. Useful to invoke code at certain point in time,
for example 1 hour before something etc. To calculate proper number you can
use time_diff filter.

form_configuration_ids (ID)

ids of forms which should trigger the api call

headers (HashObject)

Deprecated, use request_headers

manually_managed (Boolean)

defines whether this object will be manually managed, meaning it will not be affected via pos-cli deploy / sync

metadata (HashObject)

name (String)

deprecated - derived from physical_file_path; name of the api call, which is used in forms or mutation to trigger it

physical_file_path (String)

defines where the file definition will be available after pull; should start
with the module name follow by private/public scope, for example
manual/public/api_calls/my_api_call_notification

request_headers (HashObject)

request_type (String)

Liquid code which should evaluate to valid request type: Get, Post, Put,
Patch, Delete, Head or if you want to send binary files: Post_Multipart,
Put_Multipart, Patch_Multipart

to (String)

liquid code to evaluate to valid endpoint for the request.

trigger_condition (String)

liquid code which should evaluate to true if the api call should be sent