Skip to main content

​
Overview

clarife’s REST API and webhooks work with any automation platform that supports HTTP requests. Below are step-by-step guides for the three most popular tools.

​
n8n

​
Fetch Documents (HTTP Request Node)

1

Add an HTTP Request node

In your n8n workflow, add an HTTP Request node.
2

Configure the request

  • Method: GET
  • URL: https://my.clarife.app/api/v1/documents
  • Authentication: Header Auth
  • Header Name: Authorization
  • Header Value: Bearer clrf_your_key
3

Parse the response

The node returns the JSON response. Access documents via {{ $json.data }} in subsequent nodes.

​
Receive Webhook Events

1

Add a Webhook node

Add a Webhook node as the trigger for your workflow. Copy the generated URL.
2

Register in clarife

Go to Settings > API > Webhooks and create a new subscription. Paste the n8n webhook URL and select the events you want.
3

Process events

The webhook node receives the event payload. Use an IF node to branch on {{ $json.type }} (e.g. document.created, share.deleted).
// Example n8n expression to extract document title
{{ $json.data.title }}

​
Make (formerly Integromat)

​
Fetch Documents (HTTP Module)

1

Create a new scenario

Open Make and create a new scenario.
2

Add an HTTP module

Add HTTP > Make a request as the first module.
3

Configure the module

  • URL: https://my.clarife.app/api/v1/documents
  • Method: GET
  • Headers:
    • Authorization: Bearer clrf_your_key
  • Parse response: Yes
4

Use the data

Map data[] from the response to subsequent modules. Each item contains id, title, created_at, etc.

​
Receive Webhook Events

1

Add a Webhooks module

Add Webhooks > Custom webhook as the scenario trigger. Copy the URL that Make generates.
2

Register in clarife

In Settings > API > Webhooks, create a subscription with the Make webhook URL.
3

Send a test event

Click Send test event in clarife, then click Redetermine data structure in Make to auto-detect the payload fields.
4

Add a Router

Use a Router module to branch on the type field and handle different events.

​
Zapier

​
Trigger on Webhook Events

1

Create a new Zap

In Zapier, create a new Zap.
2

Choose Webhooks by Zapier

For the trigger, select Webhooks by Zapier > Catch Hook. Copy the webhook URL.
3

Register in clarife

Go to Settings > API > Webhooks and create a subscription with the Zapier webhook URL. Select the events you want.
4

Send a test event

Click Send test event in clarife, then click Test trigger in Zapier to pick up the sample payload.
5

Add an action

Add any Zapier action (Slack message, email, Google Sheet row, etc.) and map fields from the clarife event.

​
Fetch Documents via API Request

1

Add an action step

In your Zap, add an action and select Webhooks by Zapier > Custom Request.
2

Configure the request

  • Method: GET
  • URL: https://my.clarife.app/api/v1/documents
  • Headers:
    • Authorization: Bearer clrf_your_key
3

Use the response

Zapier parses the JSON response. Map data fields to subsequent steps.

​
Tips for All Platforms

Use webhooks over polling

Webhooks deliver events in real time and reduce API calls. Only poll when you need an immediate snapshot.

Verify signatures

Always verify the X-Clarife-Signature header in production. See the Webhooks guide for code examples.

Handle pagination

List endpoints return max 100 items. Use limit and offset to iterate through large datasets.

Secure your keys

Store API keys in environment variables or your platform’s secret manager. Never hardcode them in workflows.