Create certificate template
curl --request POST \
--url https://api.hixbe.com/certify/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Xerobi-Version: <xerobi-version>' \
--data '
{
"name": "Professional Certification",
"background_url": "https://example.com/certificates/professional-cert-bg.png",
"fields": [
"recipient_name",
"course_title",
"completion_date",
"instructor_name"
]
}
'import requests
url = "https://api.hixbe.com/certify/templates"
payload = {
"name": "Professional Certification",
"background_url": "https://example.com/certificates/professional-cert-bg.png",
"fields": ["recipient_name", "course_title", "completion_date", "instructor_name"]
}
headers = {
"Xerobi-Version": "<xerobi-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Xerobi-Version': '<xerobi-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Professional Certification',
background_url: 'https://example.com/certificates/professional-cert-bg.png',
fields: ['recipient_name', 'course_title', 'completion_date', 'instructor_name']
})
};
fetch('https://api.hixbe.com/certify/templates', 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.hixbe.com/certify/templates",
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([
'name' => 'Professional Certification',
'background_url' => 'https://example.com/certificates/professional-cert-bg.png',
'fields' => [
'recipient_name',
'course_title',
'completion_date',
'instructor_name'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Xerobi-Version: <xerobi-version>"
],
]);
$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.hixbe.com/certify/templates"
payload := strings.NewReader("{\n \"name\": \"Professional Certification\",\n \"background_url\": \"https://example.com/certificates/professional-cert-bg.png\",\n \"fields\": [\n \"recipient_name\",\n \"course_title\",\n \"completion_date\",\n \"instructor_name\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Xerobi-Version", "<xerobi-version>")
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.hixbe.com/certify/templates")
.header("Xerobi-Version", "<xerobi-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Professional Certification\",\n \"background_url\": \"https://example.com/certificates/professional-cert-bg.png\",\n \"fields\": [\n \"recipient_name\",\n \"course_title\",\n \"completion_date\",\n \"instructor_name\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hixbe.com/certify/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Xerobi-Version"] = '<xerobi-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Professional Certification\",\n \"background_url\": \"https://example.com/certificates/professional-cert-bg.png\",\n \"fields\": [\n \"recipient_name\",\n \"course_title\",\n \"completion_date\",\n \"instructor_name\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "tmpl_1234567890abcdef",
"name": "Professional Certification",
"created_at": "2025-12-03T10:00:00Z"
}{
"error": "invalid_request",
"message": "The credential ID provided is invalid",
"code": "INVALID_CREDENTIAL_ID"
}{
"error": "invalid_request",
"message": "The credential ID provided is invalid",
"code": "INVALID_CREDENTIAL_ID"
}{
"error": "invalid_request",
"message": "The credential ID provided is invalid",
"code": "INVALID_CREDENTIAL_ID"
}{
"error": "invalid_request",
"message": "The credential ID provided is invalid",
"code": "INVALID_CREDENTIAL_ID"
}Create Message Template
Create a new message template with variable placeholders.
Variables:
- Use double curly braces:
{{variable_name}} - Variables are case-sensitive
- No spaces in variable names
- Example:
Hello {{name}}, your code is {{code}}
Benefits:
- Consistent messaging across your application
- Easy personalization
- Reusability
- Version control
POST
/
templates
Create certificate template
curl --request POST \
--url https://api.hixbe.com/certify/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Xerobi-Version: <xerobi-version>' \
--data '
{
"name": "Professional Certification",
"background_url": "https://example.com/certificates/professional-cert-bg.png",
"fields": [
"recipient_name",
"course_title",
"completion_date",
"instructor_name"
]
}
'import requests
url = "https://api.hixbe.com/certify/templates"
payload = {
"name": "Professional Certification",
"background_url": "https://example.com/certificates/professional-cert-bg.png",
"fields": ["recipient_name", "course_title", "completion_date", "instructor_name"]
}
headers = {
"Xerobi-Version": "<xerobi-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Xerobi-Version': '<xerobi-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Professional Certification',
background_url: 'https://example.com/certificates/professional-cert-bg.png',
fields: ['recipient_name', 'course_title', 'completion_date', 'instructor_name']
})
};
fetch('https://api.hixbe.com/certify/templates', 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.hixbe.com/certify/templates",
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([
'name' => 'Professional Certification',
'background_url' => 'https://example.com/certificates/professional-cert-bg.png',
'fields' => [
'recipient_name',
'course_title',
'completion_date',
'instructor_name'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Xerobi-Version: <xerobi-version>"
],
]);
$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.hixbe.com/certify/templates"
payload := strings.NewReader("{\n \"name\": \"Professional Certification\",\n \"background_url\": \"https://example.com/certificates/professional-cert-bg.png\",\n \"fields\": [\n \"recipient_name\",\n \"course_title\",\n \"completion_date\",\n \"instructor_name\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Xerobi-Version", "<xerobi-version>")
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.hixbe.com/certify/templates")
.header("Xerobi-Version", "<xerobi-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Professional Certification\",\n \"background_url\": \"https://example.com/certificates/professional-cert-bg.png\",\n \"fields\": [\n \"recipient_name\",\n \"course_title\",\n \"completion_date\",\n \"instructor_name\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hixbe.com/certify/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Xerobi-Version"] = '<xerobi-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Professional Certification\",\n \"background_url\": \"https://example.com/certificates/professional-cert-bg.png\",\n \"fields\": [\n \"recipient_name\",\n \"course_title\",\n \"completion_date\",\n \"instructor_name\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "tmpl_1234567890abcdef",
"name": "Professional Certification",
"created_at": "2025-12-03T10:00:00Z"
}{
"error": "invalid_request",
"message": "The credential ID provided is invalid",
"code": "INVALID_CREDENTIAL_ID"
}{
"error": "invalid_request",
"message": "The credential ID provided is invalid",
"code": "INVALID_CREDENTIAL_ID"
}{
"error": "invalid_request",
"message": "The credential ID provided is invalid",
"code": "INVALID_CREDENTIAL_ID"
}{
"error": "invalid_request",
"message": "The credential ID provided is invalid",
"code": "INVALID_CREDENTIAL_ID"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
API version in YYYY-MM-DD format
Example:
"2026-01-01"
Body
application/json
Request payload for creating a new certificate template
Display name for the certificate template
Example:
"Professional Certification"
URL to the background image for the certificate
Example:
"https://example.com/certificates/professional-cert-bg.png"
Array of field names that can be populated when issuing certificates
Example:
[
"recipient_name",
"course_title",
"completion_date",
"instructor_name"
]
Response
Certificate template created successfully