Integrations & APIs

You can use Synap's APIs and Webhooks to automate your workflows, export your data and more.

API access and support is only available on Pro or enterprise plans

We have a range of API endpoints and Webhooks you can use to extend the functionality of Synap, or respond to key events that occur on your platform.

Please visit our separate API Documentation for more detailed information about how to use our API and Webhooks.

If you do not yet have API credentials, please contact us via the Chat widget.

Attribute types in the API

Attribute typeFormat required

Checkbox

TRUE or FALSE

Long answer

string

Short answer

string

Multiple choice

string

Checkboxes

string[]eg 'mycheckbox: ["maths","english","science"]

Number

Any numerical value

Date

DD/MM/YYYY

Link

Choose whether to display as text or as a button. The link can be typed as an absolute URL (opens in new tab), or a root-relative URL (open in the same tab)

File

Only .pdf files are accepted on platform or through the API. Files uploaded through the API are limited to 5mb each, or 10mb per request.

Last updated