curl --request POST \
--url https://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"protocol": "https",
"endpoint": "https://hooks.example.com/basaltic",
"raw_message_delivery": false,
"filter_policy": {
"event": [
"order.created",
"order.paid"
],
"environment": [
"production"
],
"amount": [
{
"numeric": [
">=",
100,
"<",
1000
]
}
],
"test": [
{
"exists": false
}
]
},
"delivery_policy": {
"max_attempts": 6,
"min_delay_seconds": 20,
"max_delay_seconds": 1200,
"timeout_seconds": 15
},
"tags": {
"environment": "production",
"team": "backend"
}
}
'import requests
url = "https://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions"
payload = {
"protocol": "https",
"endpoint": "https://hooks.example.com/basaltic",
"raw_message_delivery": False,
"filter_policy": {
"event": ["order.created", "order.paid"],
"environment": ["production"],
"amount": [{ "numeric": [">=", 100, "<", 1000] }],
"test": [{ "exists": False }]
},
"delivery_policy": {
"max_attempts": 6,
"min_delay_seconds": 20,
"max_delay_seconds": 1200,
"timeout_seconds": 15
},
"tags": {
"environment": "production",
"team": "backend"
}
}
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({
protocol: 'https',
endpoint: 'https://hooks.example.com/basaltic',
raw_message_delivery: false,
filter_policy: {
event: ['order.created', 'order.paid'],
environment: ['production'],
amount: [{numeric: ['>=', 100, '<', 1000]}],
test: [{exists: false}]
},
delivery_policy: {
max_attempts: 6,
min_delay_seconds: 20,
max_delay_seconds: 1200,
timeout_seconds: 15
},
tags: {environment: 'production', team: 'backend'}
})
};
fetch('https://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions', 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://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions",
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([
'protocol' => 'https',
'endpoint' => 'https://hooks.example.com/basaltic',
'raw_message_delivery' => false,
'filter_policy' => [
'event' => [
'order.created',
'order.paid'
],
'environment' => [
'production'
],
'amount' => [
[
'numeric' => [
'>=',
100,
'<',
1000
]
]
],
'test' => [
[
'exists' => false
]
]
],
'delivery_policy' => [
'max_attempts' => 6,
'min_delay_seconds' => 20,
'max_delay_seconds' => 1200,
'timeout_seconds' => 15
],
'tags' => [
'environment' => 'production',
'team' => 'backend'
]
]),
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://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions"
payload := strings.NewReader("{\n \"protocol\": \"https\",\n \"endpoint\": \"https://hooks.example.com/basaltic\",\n \"raw_message_delivery\": false,\n \"filter_policy\": {\n \"event\": [\n \"order.created\",\n \"order.paid\"\n ],\n \"environment\": [\n \"production\"\n ],\n \"amount\": [\n {\n \"numeric\": [\n \">=\",\n 100,\n \"<\",\n 1000\n ]\n }\n ],\n \"test\": [\n {\n \"exists\": false\n }\n ]\n },\n \"delivery_policy\": {\n \"max_attempts\": 6,\n \"min_delay_seconds\": 20,\n \"max_delay_seconds\": 1200,\n \"timeout_seconds\": 15\n },\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\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://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"protocol\": \"https\",\n \"endpoint\": \"https://hooks.example.com/basaltic\",\n \"raw_message_delivery\": false,\n \"filter_policy\": {\n \"event\": [\n \"order.created\",\n \"order.paid\"\n ],\n \"environment\": [\n \"production\"\n ],\n \"amount\": [\n {\n \"numeric\": [\n \">=\",\n 100,\n \"<\",\n 1000\n ]\n }\n ],\n \"test\": [\n {\n \"exists\": false\n }\n ]\n },\n \"delivery_policy\": {\n \"max_attempts\": 6,\n \"min_delay_seconds\": 20,\n \"max_delay_seconds\": 1200,\n \"timeout_seconds\": 15\n },\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions")
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 \"protocol\": \"https\",\n \"endpoint\": \"https://hooks.example.com/basaltic\",\n \"raw_message_delivery\": false,\n \"filter_policy\": {\n \"event\": [\n \"order.created\",\n \"order.paid\"\n ],\n \"environment\": [\n \"production\"\n ],\n \"amount\": [\n {\n \"numeric\": [\n \">=\",\n 100,\n \"<\",\n 1000\n ]\n }\n ],\n \"test\": [\n {\n \"exists\": false\n }\n ]\n },\n \"delivery_policy\": {\n \"max_attempts\": 6,\n \"min_delay_seconds\": 20,\n \"max_delay_seconds\": 1200,\n \"timeout_seconds\": 15\n },\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"id": "b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"crn": "crn:notifications:sa-saopaulo-1:my-account:topic/orders/subscription/b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"protocol": "https",
"endpoint": "https://hooks.example.com/basaltic",
"status": "confirmed",
"raw_message_delivery": false,
"created_at": "2026-01-18T09:30:00Z",
"updated_at": "2026-01-18T09:31:00Z",
"filter_policy": {
"event": [
"order.created",
"order.paid"
],
"environment": [
"production"
],
"amount": [
{
"numeric": [
">=",
100,
"<",
1000
]
}
],
"test": [
{
"exists": false
}
]
},
"delivery_policy": {
"max_attempts": 6,
"min_delay_seconds": 20,
"max_delay_seconds": 1200,
"timeout_seconds": 15
},
"redrive_policy": {
"dead_letter_queue": {
"id": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
"crn": "crn:queue:sa-saopaulo-1:my-account:queue/notification-failures",
"name": "notification-failures"
}
},
"confirmation_expires_at": "2026-01-21T09:30:00Z",
"confirmed_at": "2026-01-18T09:31:00Z",
"tags": {
"environment": "production",
"team": "backend"
}
},
"signing_secret": "kJ8vQ2xR5tY7uI0oP3aS6dF9gH1jK4lZ7xC0vB3nM6Q"
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "CONFLICT",
"message": "Resource with this name already exists",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Assinar um tópico com um destino
O tópico pai é selecionado por topic_id no caminho. Tópicos externos exigem autorização bilateral de Subscribe. Email e webhooks começam em pending_confirmation; nada é entregue até a confirmação. Filas são confirmadas após autorização do destino.
Idempotente por (topic, protocol, endpoint): repetir retorna a assinatura existente, sem signing_secret, preservando a verificação de assinaturas. O segredo aparece uma vez, na primeira criação http/https. Armazene-o ou consulte o endpoint de segredo depois.
curl --request POST \
--url https://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"protocol": "https",
"endpoint": "https://hooks.example.com/basaltic",
"raw_message_delivery": false,
"filter_policy": {
"event": [
"order.created",
"order.paid"
],
"environment": [
"production"
],
"amount": [
{
"numeric": [
">=",
100,
"<",
1000
]
}
],
"test": [
{
"exists": false
}
]
},
"delivery_policy": {
"max_attempts": 6,
"min_delay_seconds": 20,
"max_delay_seconds": 1200,
"timeout_seconds": 15
},
"tags": {
"environment": "production",
"team": "backend"
}
}
'import requests
url = "https://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions"
payload = {
"protocol": "https",
"endpoint": "https://hooks.example.com/basaltic",
"raw_message_delivery": False,
"filter_policy": {
"event": ["order.created", "order.paid"],
"environment": ["production"],
"amount": [{ "numeric": [">=", 100, "<", 1000] }],
"test": [{ "exists": False }]
},
"delivery_policy": {
"max_attempts": 6,
"min_delay_seconds": 20,
"max_delay_seconds": 1200,
"timeout_seconds": 15
},
"tags": {
"environment": "production",
"team": "backend"
}
}
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({
protocol: 'https',
endpoint: 'https://hooks.example.com/basaltic',
raw_message_delivery: false,
filter_policy: {
event: ['order.created', 'order.paid'],
environment: ['production'],
amount: [{numeric: ['>=', 100, '<', 1000]}],
test: [{exists: false}]
},
delivery_policy: {
max_attempts: 6,
min_delay_seconds: 20,
max_delay_seconds: 1200,
timeout_seconds: 15
},
tags: {environment: 'production', team: 'backend'}
})
};
fetch('https://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions', 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://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions",
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([
'protocol' => 'https',
'endpoint' => 'https://hooks.example.com/basaltic',
'raw_message_delivery' => false,
'filter_policy' => [
'event' => [
'order.created',
'order.paid'
],
'environment' => [
'production'
],
'amount' => [
[
'numeric' => [
'>=',
100,
'<',
1000
]
]
],
'test' => [
[
'exists' => false
]
]
],
'delivery_policy' => [
'max_attempts' => 6,
'min_delay_seconds' => 20,
'max_delay_seconds' => 1200,
'timeout_seconds' => 15
],
'tags' => [
'environment' => 'production',
'team' => 'backend'
]
]),
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://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions"
payload := strings.NewReader("{\n \"protocol\": \"https\",\n \"endpoint\": \"https://hooks.example.com/basaltic\",\n \"raw_message_delivery\": false,\n \"filter_policy\": {\n \"event\": [\n \"order.created\",\n \"order.paid\"\n ],\n \"environment\": [\n \"production\"\n ],\n \"amount\": [\n {\n \"numeric\": [\n \">=\",\n 100,\n \"<\",\n 1000\n ]\n }\n ],\n \"test\": [\n {\n \"exists\": false\n }\n ]\n },\n \"delivery_policy\": {\n \"max_attempts\": 6,\n \"min_delay_seconds\": 20,\n \"max_delay_seconds\": 1200,\n \"timeout_seconds\": 15\n },\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\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://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"protocol\": \"https\",\n \"endpoint\": \"https://hooks.example.com/basaltic\",\n \"raw_message_delivery\": false,\n \"filter_policy\": {\n \"event\": [\n \"order.created\",\n \"order.paid\"\n ],\n \"environment\": [\n \"production\"\n ],\n \"amount\": [\n {\n \"numeric\": [\n \">=\",\n 100,\n \"<\",\n 1000\n ]\n }\n ],\n \"test\": [\n {\n \"exists\": false\n }\n ]\n },\n \"delivery_policy\": {\n \"max_attempts\": 6,\n \"min_delay_seconds\": 20,\n \"max_delay_seconds\": 1200,\n \"timeout_seconds\": 15\n },\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://notifications.{region}.basaltic.sh/v1/topics/{topic_id}/subscriptions")
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 \"protocol\": \"https\",\n \"endpoint\": \"https://hooks.example.com/basaltic\",\n \"raw_message_delivery\": false,\n \"filter_policy\": {\n \"event\": [\n \"order.created\",\n \"order.paid\"\n ],\n \"environment\": [\n \"production\"\n ],\n \"amount\": [\n {\n \"numeric\": [\n \">=\",\n 100,\n \"<\",\n 1000\n ]\n }\n ],\n \"test\": [\n {\n \"exists\": false\n }\n ]\n },\n \"delivery_policy\": {\n \"max_attempts\": 6,\n \"min_delay_seconds\": 20,\n \"max_delay_seconds\": 1200,\n \"timeout_seconds\": 15\n },\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n }\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"id": "b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"crn": "crn:notifications:sa-saopaulo-1:my-account:topic/orders/subscription/b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"protocol": "https",
"endpoint": "https://hooks.example.com/basaltic",
"status": "confirmed",
"raw_message_delivery": false,
"created_at": "2026-01-18T09:30:00Z",
"updated_at": "2026-01-18T09:31:00Z",
"filter_policy": {
"event": [
"order.created",
"order.paid"
],
"environment": [
"production"
],
"amount": [
{
"numeric": [
">=",
100,
"<",
1000
]
}
],
"test": [
{
"exists": false
}
]
},
"delivery_policy": {
"max_attempts": 6,
"min_delay_seconds": 20,
"max_delay_seconds": 1200,
"timeout_seconds": 15
},
"redrive_policy": {
"dead_letter_queue": {
"id": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
"crn": "crn:queue:sa-saopaulo-1:my-account:queue/notification-failures",
"name": "notification-failures"
}
},
"confirmation_expires_at": "2026-01-21T09:30:00Z",
"confirmed_at": "2026-01-18T09:31:00Z",
"tags": {
"environment": "production",
"team": "backend"
}
},
"signing_secret": "kJ8vQ2xR5tY7uI0oP3aS6dF9gH1jK4lZ7xC0vB3nM6Q"
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "CONFLICT",
"message": "Resource with this name already exists",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}notifications:Subscribe. Veja NOTIFICATIONS permissões para a lista completa, o escopo de cada ação e um exemplo de política.Autorizações
Um token bearer OAuth 2.0, enviado como Authorization: Bearer <token>. Esta é a forma recomendada de autenticação.
Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em POST /v1/oauth/token com grant_type=client_credentials. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação.
Cabeçalhos
Chave opcional gerada pelo cliente que torna uma criação segura para reprodução. A reintentar uma solicitação com a mesma chave retorna o resultado original literalmente em vez de criar um recurso duplicado. A reutilização de uma chave com um corpo de solicitação diferente é rejeitada (422); uma solicitação cuja chave ainda está sendo processada retorna 409. Os registros são honrados por 24 horas. Use um UUID ou token exclusivo semelhante.
255Parâmetros de caminho
"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
Corpo
email, https, http, queue "https"
Endereço de email, URL http/https com esquema correspondente ao protocolo e endereço publicamente roteável ou, para queue, UUID, CRN ou nome exato de uma fila na conta e região do assinante. Filas são armazenadas e retornadas como CRNs canônicos. Assinaturas de fila já são confirmadas ao criar: o consentimento é verificado pela permissão queue:SendMessage. Email e webhooks exigem confirmação do proprietário do destino.
2048"https://hooks.example.com/basaltic"
Somente http/https.
false
Filtra atributos da publicação, não campos do corpo. Cada atributo deve corresponder a uma alternativa: AND entre nomes e OR dentro de cada lista. Nomes e comparações distinguem maiúsculas. Política omitida ou vazia aceita todas as mensagens.
Alternativas: strings ou números exatos, ou objetos com um operador: {"prefix": "order."}, {"suffix": ".failed"}, {"anything-but": ["debug", "trace"]}, {"exists": true}, {"exists": false} ou {"numeric": [">=", 100, "<", 1000]}. Prefixos e sufixos não podem ser vazios. anything-but aceita uma string, número ou lista de 1–50 valores.
Somente exists: false aceita atributo ausente. Exclusão também exige presença. Operadores numéricos: =, <, <=, > e >=; todos os pares devem ser verdadeiros. Valores não numéricos não correspondem. Números simples comparam representações textuais; use numeric para equivalência entre "100" e "100.0".
Até 20 nomes não vazios, com 1–50 alternativas por nome. Um operador por objeto. Não há curingas, expressões regulares, filtros no corpo ou operadores aninhados. PATCH substitui a política inteira; {} limpa e omissão preserva. Veja Políticas de filtro.
Show child attributes
Show child attributes
{
"event": ["order.created", "order.paid"],
"environment": ["production"],
"amount": [{ "numeric": [">=", 100, "<", 1000] }],
"test": [{ "exists": false }]
}
Política de tentativas. Campos omitidos herdam o tópico e depois os padrões: 6 tentativas, espera exponencial de 20s a 20min com variação aleatória e timeout de 15s. A herança ocorre por campo; alterar max_attempts preserva a curva do tópico.
Show child attributes
Show child attributes
Fila da conta do assinante que recebe falhas definitivas como mensagens delivery_failure, com a notificação original e um bloco failure contendo ID, destino, tentativas, último erro e status. Sem fila, as falhas continuam disponíveis nos registros e métricas. Exige queue:SendMessage ao definir a política. Em assinaturas de fila, o destino deve ser diferente da fila assinada.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
{
"environment": "production",
"team": "backend"
}
Resposta
Assinatura criada ou existente retornada.

