Send a Binary File in an API Call

Prerequisites

To follow this tutorial, you must understand basic Insites concepts, HTML, Liquid, APIs, Notifications, and Forms.

• Development Workflow
• Forms
• Liquid
• GraphQL
• Creating an API Call Notification

Steps

Sending a binary file using an API Call Notification is a particular case of creating regular API Call Notifications as described in Creating an API Call Notification. This tutorial explains the difference between a standard request and sending a file, so it consists of only one step: creating an API call notification.

app/api_calls/send_file.liquid

---
name: send_file
to: "https://example.com/endpoint"
format: http
request_type: post_multipart
---
{
  "file": {
    "url": "https://domain.com/my-file.jpg",
    "name": "my-file.jpg",
    "content_type": "image/jpeg"
  },
  "file2": {
    "url": "https://domain.com/other-file.jpg",
    "name": "other-file.jpg",
    "content_type": "image/jpeg"
  }
}

This step defines a POST request to the endpoint, which would send two binary files. The main difference between a regular API call and sending a binary file is the suffix in the request type. Valid request types are , and . The required body format for requests is JSON following structure:

{
  "<param name>": {
    "url": "<required url to file remote location>",
    "name": "<optional file name>",
    "content_type": "<optional content type>"
  }
}