# Integrations & APIs

{% hint style="info" %}
Webhooks are on Pro, Business and Enterprise plans<br>

Pro plans get access to Synap's Org API endpoints at <https://docs.synap.ac/>&#x20;

Business and Enterprise plans get access to our V3 API at <https://api-docs.synap.ac/> which includes everything on the Org API and more
{% endhint %}

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.&#x20;

Please visit the corresponding API docs for your plan, for the Org API (Pro) you'll need to request credentials which you can do from the chat on platform at any time.&#x20;

### Attribute types in the API&#x20;

Synap supports a range of custom attributes across key areas on the platform head over to Settings>Data Management>Attributes to create and manage attributes.&#x20;

Attributes are let you create additional fields which can be included and updated in API requests, helpful for storing things like: Re-certification dates, country, latest / average score. These custom attribute values will be included in relevant API payloads.&#x20;

&#x20;Learn more about attributes in our docs below

{% content-ref url="/pages/vJsglaSbW0ujvIgs8DX4" %}
[Attributes](/doc/portal-settings/data-management/attributes.md)
{% endcontent-ref %}

| Attribute type  | Format 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.                 |

<figure><img src="/files/y4VmNUI5tw2mIBz11oNo" alt=""><figcaption><p>Attribute manage on platform (Business / Enterprise options)</p></figcaption></figure>

{% content-ref url="/pages/lLtdnh347vvEx2haHEMJ" %}
[Webhooks](/doc/integrations/webhooks.md)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://academy.synap.ac/doc/integrations/integrations-and-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.