Insites Docs Developers guide APISending a Binary File Using an API Call Notification

Sending a Binary File Using an API Call Notification

Last updated on June 26, 2024.

This guide details how to send a file using an API Call Notification.

Prerequisites

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

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

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:

Important

If the URL includes special characters, for example, (which is the case for private uploads), please make sure to use the filter.

Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.