Skip to main content
POST
/
api
/
v1
/
webhooks
Create webhook
curl --request POST \
  --url https://api.torpedo.co.mz/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "https://myapp.com/webhooks/torpedo",
  "events": [
    "email.delivered",
    "email.bounced",
    "email.failed"
  ]
}
'
import requests

url = "https://api.torpedo.co.mz/api/v1/webhooks"

payload = {
"url": "https://myapp.com/webhooks/torpedo",
"events": ["email.delivered", "email.bounced", "email.failed"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://myapp.com/webhooks/torpedo',
events: ['email.delivered', 'email.bounced', 'email.failed']
})
};

fetch('https://api.torpedo.co.mz/api/v1/webhooks', 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.torpedo.co.mz/api/v1/webhooks",
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([
'url' => 'https://myapp.com/webhooks/torpedo',
'events' => [
'email.delivered',
'email.bounced',
'email.failed'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$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.torpedo.co.mz/api/v1/webhooks"

payload := strings.NewReader("{\n \"url\": \"https://myapp.com/webhooks/torpedo\",\n \"events\": [\n \"email.delivered\",\n \"email.bounced\",\n \"email.failed\"\n ]\n}")

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

req.Header.Add("X-API-Key", "<api-key>")
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.torpedo.co.mz/api/v1/webhooks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://myapp.com/webhooks/torpedo\",\n \"events\": [\n \"email.delivered\",\n \"email.bounced\",\n \"email.failed\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.torpedo.co.mz/api/v1/webhooks")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://myapp.com/webhooks/torpedo\",\n \"events\": [\n \"email.delivered\",\n \"email.bounced\",\n \"email.failed\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "https://myapp.com/webhooks/torpedo",
    "events": [
      "email.delivered",
      "email.bounced"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "lastDeliveryAt": "2023-11-07T05:31:56Z",
    "lastFailureAt": "2023-11-07T05:31:56Z",
    "lastFailureReason": "<string>",
    "signingSecret": "a3f2c1..."
  }
}
{
"errors": [
{
"message": "Domain not verified",
"field": "from"
}
]
}

Authorizations

X-API-Key
string
header
required

Prefix tor_ followed by a base64url-encoded random key. Obtain one from POST /api/v1/workspaces or POST /api/v1/auth/keys.

Body

application/json
url
string<uri>
required

Must be an HTTPS URL

Example:

"https://myapp.com/webhooks/torpedo"

events
enum<string>[]
required
Minimum array length: 1
Available options:
email.delivered,
email.bounced,
email.complained,
email.failed,
domain.verified,
domain.failed
Example:
[
"email.delivered",
"email.bounced",
"email.failed"
]

Response

Webhook created — store the signingSecret now

data
object