Mergent
Search…
Quick Start
Get up and running with Mergent Tasks in minutes.
  1. 1.
    Obtain your API keys so Mergent can authenticate your API requests
  2. 2.
    Configure your server to receive task webhooks
  3. 3.
    Create your first task to confirm everything is up and running

Obtain your API keys

Mergent authenticates your API requests using your project API keys. If you don't include your key when making an API request or use one that is incorrect or outdated, Mergent returns an error.
API keys are obtained on the Project Settings screen: https://app.mergent.co/project/settings

Configure your server to receive task webhooks

Mergent uses webhooks to notify your application when a task is ready to be performed.
For each task, Mergent POSTs the task data to your endpoint in JSON format. At a minimum, your webhook endpoint needs to expect data through a POST request and confirm successful receipt of that data.
To acknowledge receipt of a Task, your endpoint must return a 200 or 201 HTTP status code to Mergent. All response codes outside this range, including 3xx codes, indicate to Mergent that you did not receive the Task.
If Mergent does not receive a 2xx HTTP status code, the notification attempt is repeated. After multiple failures to send the notification over multiple days, Mergent marks the Task as failed and stops trying to send it to your endpoint.
There are example implementations in the sidebar for some common libraries & frameworks.

Create your first task

To check that your integration is working correctly, make a test API request using your API key to create a task.
Using Ruby, JavaScript, TypeScript, or Ruby? There's a library. See the JavaScript / TypeScript or Ruby pages for details. Using another language? For now, you'll have to make an API request manually. We plan on supporting other languages natively soon.
Here's an example using curl.
1
curl https://api.mergent.co/v1/tasks \
2
-u yourapikey: \
3
-d request[url]="https://example.com/webhook"
Copied!
For all of the available configurations & parameters, please visit the API reference in the sidebar.