Last edit: Jun 10, 2024

ApiCall Notification

type ApiCallNotification implements AdminSharedAttributesInterface {
  callback: String
  content: String
  created_at: JSONDate!
  delay_by: String
  form_configurations: [FormConfiguration!]
  forms: [Form!]
  headers: String
  id: ID!
  manually_managed: Boolean
  metadata: HashObject
  name: String!
  physical_file_path: String
  request_type: String!
  to: String!
  trigger_condition: String
  updated_at: JSONDate!


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, for example a JSON.

created_at (JSONDate)

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_configurations (FormConfiguration)

form configurations which trigger the email

forms (Form)

forms which trigger the email

headers (String)

liquid code to evaluate to valid json of request headers

id (ID)

manually_managed (Boolean)

defines whether this objectwill be affected via pos-cli deploy / sync

metadata (HashObject)

name (String)

name of the api call, which is used in form_configurations or mutation to trigger it

physical_file_path (String)

defines the physical path of the file

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

updated_at (JSONDate)




We are always happy to help with any questions you may have.

contact us