API-based Job

Overview

API-based jobs allow users to build integrations with Soroban platform using simple HTTP requests. When user creates an API job they receive an HTTP endpoint that acts as a webhook for triggering the job. This means that user can assign any custom logic to when the smart contract function will invoked via the HTPP request. This action can be performed by:

• Using numerous automation and no-code platforms

• Via custom code written in any programming language

Skeeper provides an intuitive user interface for configuring smart contract invokations. It also handles execution and response handling.

Tutorial

Create API-based job

In Skeeper UI go to API-based jobs and press "Add Task". Populate the form with desired Soroban smart contract parameters.

Retrieve JobId and Api key

For API key click on the user icon in the top right corner.

For job id (not possible to retrieve yet)

Create an HTTP request

Make a POST request to https://triggerjob-n7ps3nkq5a-uc.a.run.app

The body must be the following

```

{

"jobId": "[INSERT YOUR JOB ID]",

"apiKey": "[INSERT YOUR API KEYS]"

}

```

You will receive 200 status code in case of successful execution