Overview
Get Integration Guide
Get a framework-specific API integration example
POST
/
api
/
v1
/
integration-guide
Get Integration Guide
curl --request POST \
--url https://api.sequenzy.com/api/v1/integration-guide \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"framework": "<string>",
"use_case": "<string>"
}
'import requests
url = "https://api.sequenzy.com/api/v1/integration-guide"
payload = {
"framework": "<string>",
"use_case": "<string>"
}
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({framework: '<string>', use_case: '<string>'})
};
fetch('https://api.sequenzy.com/api/v1/integration-guide', 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://api.sequenzy.com/api/v1/integration-guide",
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([
'framework' => '<string>',
'use_case' => '<string>'
]),
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://api.sequenzy.com/api/v1/integration-guide"
payload := strings.NewReader("{\n \"framework\": \"<string>\",\n \"use_case\": \"<string>\"\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://api.sequenzy.com/api/v1/integration-guide")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"framework\": \"<string>\",\n \"use_case\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/integration-guide")
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 \"framework\": \"<string>\",\n \"use_case\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"framework": "nextjs",
"use_case": "transactional",
"code": "await fetch('https://api.sequenzy.com/api/v1/transactional/send', ...)",
"tip": "For transactional emails, make sure to set up a verified sending domain in the dashboard for best deliverability."
}
{
"success": false,
"error": "Unauthorized"
}
Get a short code example and implementation tip for a framework and use case.
For a static-site signup form, the response points you to
Request
string
Framework or deployment description. Defaults to
nextjs. For
subscribe_form, values containing static, astro, hugo, jekyll,
cloudflare pages, netlify, or github pages return the client-safe Saved
Forms workflow instead of secret-key subscriber API code.string
Use case key:
transactional, subscribe_form, event_tracking, or
ecommerce. Defaults to transactional.curl -X POST "https://api.sequenzy.com/api/v1/integration-guide" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"framework": "nextjs", "use_case": "transactional"}'
Responses
{
"success": true,
"framework": "nextjs",
"use_case": "transactional",
"code": "await fetch('https://api.sequenzy.com/api/v1/transactional/send', ...)",
"tip": "For transactional emails, make sure to set up a verified sending domain in the dashboard for best deliverability."
}
{
"success": false,
"error": "Unauthorized"
}
list_forms,
create_form, and get_form_embed, then returns a native form action shaped
like https://api.sequenzy.com/api/v1/forms/{formId}. That deployed action does
not require an API key because its audience and success behavior are controlled
by the saved form.⌘I
Get Integration Guide
curl --request POST \
--url https://api.sequenzy.com/api/v1/integration-guide \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"framework": "<string>",
"use_case": "<string>"
}
'import requests
url = "https://api.sequenzy.com/api/v1/integration-guide"
payload = {
"framework": "<string>",
"use_case": "<string>"
}
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({framework: '<string>', use_case: '<string>'})
};
fetch('https://api.sequenzy.com/api/v1/integration-guide', 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://api.sequenzy.com/api/v1/integration-guide",
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([
'framework' => '<string>',
'use_case' => '<string>'
]),
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://api.sequenzy.com/api/v1/integration-guide"
payload := strings.NewReader("{\n \"framework\": \"<string>\",\n \"use_case\": \"<string>\"\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://api.sequenzy.com/api/v1/integration-guide")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"framework\": \"<string>\",\n \"use_case\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/integration-guide")
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 \"framework\": \"<string>\",\n \"use_case\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"framework": "nextjs",
"use_case": "transactional",
"code": "await fetch('https://api.sequenzy.com/api/v1/transactional/send', ...)",
"tip": "For transactional emails, make sure to set up a verified sending domain in the dashboard for best deliverability."
}
{
"success": false,
"error": "Unauthorized"
}