Run provider setup step

Run a supported follow-up setup step for a connected provider, such as CRM mappings or webhook setup.

POST /api/integrations/setup-step

Run provider setup step

cURL

curl --request POST \
  --url https://app.outlit.ai/api/integrations/setup-step \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "step": "<string>",
  "config": {}
}
'

import requests

url = "https://app.outlit.ai/api/integrations/setup-step"

payload = {
    "step": "<string>",
    "config": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({step: '<string>', config: {}})
};

fetch('https://app.outlit.ai/api/integrations/setup-step', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.outlit.ai/api/integrations/setup-step",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'step' => '<string>',
    'config' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.outlit.ai/api/integrations/setup-step"

	payload := strings.NewReader("{\n  \"step\": \"<string>\",\n  \"config\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.outlit.ai/api/integrations/setup-step")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"step\": \"<string>\",\n  \"config\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.outlit.ai/api/integrations/setup-step")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"step\": \"<string>\",\n  \"config\": {}\n}"

response = http.request(request)
puts response.read_body

200

{}

{
  "error": "Invalid request"
}

{
  "error": "Invalid credentials"
}

{
  "error": "Internal server error"
}

Authorizations

Authorization · string · header · required

Outlit API key using the Bearer ok_... format.

Body

application/json

provider · enum<string> · required

Public integration provider ID.

Available options: hubspot, attio, slack, fireflies, granola, google-calendar, google-mail, posthog, stripe, supabase, clerk, pylon

step · string · required

Minimum string length: 1

Examples:

"mappings"

"webhooks"

config · object

Response

200

application/json

Step-specific setup response.

The response is of type object.