Gin

This quickstart applies to one-off tasks and recurring cron and rrule schedules.

1. Define your task

Your task definition is where you'll perform your tasks, such as sending emails, processing files, or moving data between systems.

With Mergent, tasks are defined by HTTP request handlers inside your application.

main.go

package main

import (
	"log"

	"github.com/gin-gonic/gin"
)

func main() {
	r := gin.Default()

	r.POST("/api/tasks", func(c *gin.Context) {
		body, _ := c.GetRawData()

		err := performTask(string(body))
		if err != nil {
			// task failed, respond with 500 so Mergent will retry
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		// task was successful, respond with 200
		c.Status(http.StatusOK)
	})

	r.Run(":3000")
}

func performTask(body string) error {
	// This is where you'll perform your task.
	// For now, we'll just log it.
	log.Println("Performing task: ", body)

	return nil
}

For a list of all the available parameters, visit the API Reference.

2. Get your handler's URL

Before you can run your task, your handler must be accessible from the internet.

To do this, you can use a tool like ngrok, or deploy your application to a platform like Vercel or Render.

For more information, see our guide to localhost dev & webhooks.

3. Create your first task

Once your task handler is reachable via a URL, you can create your first task. Go to the Mergent Tasks Dashboard and click the Create button.

In this step, you'll set the Request URL to your task handler's URL. You'll also provide the required parameters (in the request body) for your handler to carry out the task.

Typically, developers use a type parameter to distinguish between different tasks. This allows your task handler to route and process tasks accordingly. Feel free to structure your parameters in a way that works best for your application.

Click Create to queue the task. Once the task executes, you should see the related log in your console, indicating a successful run. 🎊

4. Next Steps

At this point, you have a few options:

1. Obtain your API keys

Mergent authenticates all requests using project API keys.

API keys can be obtained from the Project Settings screen in the Dashboard.

2. Create your task

Create a task whenever you need to. For example, you might create a task any time a user signs up.

Use the URL of the task definition you'd like to run.

package main

import (
	"bytes"
	"encoding/json"
	"io"
	"log"
	"net/http"
)

func main() {
	// set the Mergent API key
	apiKey := "..."

	// create a task
	// the URL should be set to the URL of your task handler
	task := struct {
		Request struct {
			URL  string `json:"url"`
			Body string `json:"body"`
		} `json:"request"`
	}{
		Request: struct {
			URL  string `json:"url"`
			Body string `json:"body"`
		}{
			URL:  "...",
			Body: "Hello, world!",
		},
	}

	taskJSON, _ := json.Marshal(task)

	req, err := http.NewRequest(http.MethodPost, "https://api.mergent.io/tasks", bytes.NewBuffer(taskJSON))
	if err != nil {
		log.Fatalln(err)
	}

	req.Header.Add("Authorization", "Bearer "+apiKey)

	client := &http.Client{}
	res, err := client.Do(req)
	if err != nil {
		log.Fatalln(err)
	}
	defer res.Body.Close()

	if res.StatusCode != http.StatusCreated {
		log.Fatalln("Failed to create task")
	}

	resBody, _ := io.Readall(res.Body)
	var resTask map[string]any
	if err := json.Unmarshal(resBody, &resTask); err != nil {
		log.Fatalln(err)
	}

	log.Println(resTask)
}

You can now create a task any time you'd like to perform some work in the background. 🎊

Learn More

Tasks & Schedules

Better understand the two core concepts of Mergent: tasks & schedules

How Tasks Work

Learn more about tasks for one-off asynchronous workloads

How Schedules Work

Learn more about schedules and how they create tasks

Request Failures & Retries

Learn how Mergent retries tasks when they fail

Getting Started

Quickstart

Concepts

Guides

1. Define your task

2. Get your handler's URL

3. Create your first task

4. Next Steps

1. Obtain your API keys

2. Create your task

Learn More

Tasks & Schedules

How Tasks Work

How Schedules Work

Request Failures & Retries

Getting Started

Quickstart

Concepts

Guides

​1. Define your task

​2. Get your handler's URL

​3. Create your first task

​4. Next Steps

1. Obtain your API keys

2. Create your task

​Learn More

Tasks & Schedules

How Tasks Work

How Schedules Work

Request Failures & Retries

1. Define your task

2. Get your handler's URL

3. Create your first task

4. Next Steps

Learn More