ApiCallNotification

API call template (app/api_calls): an HTTP request to an external endpoint, sent with the api_call_send mutation

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!
}

Fields

callback (String)

Liquid run after the response is received, with access to it as the response
variable (response.code, response.body, response.headers)

content (String)

Liquid that evaluates to the request body, for example a JSON document

created_at (JSONDate)

Timestamp of when the object was created, set automatically by the system

delay_by (String)

Number of minutes to wait before sending the request. Ignored by
api_call_send, which always sends the request immediately. Defaults to 0

form_configurations (FormConfiguration)

Deprecated, legacy forms that send this API call

forms (Form)

Deprecated, legacy forms that send this API call

headers (String)

Liquid that evaluates to a JSON object of request headers

id (ID)

Unique identifier of the object

manually_managed (Boolean)

When true, the resource is managed outside of files: pos-cli deploy and sync never overwrite or delete it

metadata (HashObject)

Free-form data attached to the resource with the metadata key of its file (or the metadata argument of an admin mutation)

name (String)

Name of the API call, used to send it with the api_call_send mutation

physical_file_path (String)

Path of the file the resource comes from, relative to the app directory, for
example views/pages/index.liquid or
modules/my_module/public/views/partials/header.liquid. Identifies the resource
in deploy, sync and admin mutations

request_type (String)

Liquid that evaluates to the HTTP method of the request: Get, Post, Put,
Patch, Delete, Head, or to send files as multipart/form-data: Post_Multipart,
Put_Multipart, Patch_Multipart

to (String)

Liquid that evaluates to the URL the request is sent to

trigger_condition (String)

Liquid that evaluates to true (or t) when the request should be sent; any other result skips it. Defaults to true

updated_at (JSONDate)

Timestamp of when the object was last updated, set automatically by the system

Interfaces

AdminSharedAttributesInterface

Attributes shared by resources that can be deployed from files with pos-cli
(pages, partials, layouts, notifications, authorization policies, schemas, assets etc.)