ApiCallNotificationInputType

Attributes of an API call, the same ones that can be set in an api_calls/*.liquid file

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 run after the response is received; the response is available in the response variable

content (String)

Liquid code rendered into the request body, for example a JSON document

delay_by (String)

Number of minutes the request is delayed by. Ignored by api_call_send, which
always sends the request immediately. Defaults to 0

form_configuration_ids (ID)

Deprecated, ignored. Ids of legacy forms

headers (HashObject)

Deprecated, use request_headers

manually_managed (Boolean)

When true, pos-cli deploy and sync never overwrite or delete it and pos-cli
pull skips it. When omitted, defaults to the track_manually_managed setting of
the instance (false unless enabled in app/config.yml)

metadata (HashObject)

Arbitrary JSON data stored with the API call (the metadata section of the file)

name (String)

Deprecated, the name is derived from physical_file_path. Name used to send the API call with the api_call_send mutation

physical_file_path (String)

Path of the file the API call is stored as, used by pos-cli pull and deploy.
Must be api_calls/<name>.liquid (or legacy
notifications/api_call_notifications/<name>.liquid), optionally prefixed
with modules/<module_name>/public/ or modules/<module_name>/private/, for
example modules/my_module/public/api_calls/welcome.liquid

request_headers (HashObject)

Request headers as a JSON object, for example { "Content-Type": "application/json" }; values may contain Liquid

request_type (String)

Liquid code rendering to the HTTP method: Get, Post, Put, Patch, Delete, Head,
or to send binary files as multipart form data: Post_Multipart, Put_Multipart,
Patch_Multipart

to (String)

Liquid code rendering to the URL the request is sent to

trigger_condition (String)

Liquid code; the API call is sent only when it renders to true. Defaults to true