Create an API key
curl --request POST \
--url https://api.pulsewave.dev/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Production backend",
"scopes": [
"messages:write",
"messages:read"
]
}
'import requests
url = "https://api.pulsewave.dev/v1/api-keys"
payload = {
"name": "Production backend",
"scopes": ["messages:write", "messages:read"]
}
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({name: 'Production backend', scopes: ['messages:write', 'messages:read']})
};
fetch('https://api.pulsewave.dev/v1/api-keys', 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.pulsewave.dev/v1/api-keys",
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' => 'Production backend',
'scopes' => [
'messages:write',
'messages:read'
]
]),
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.pulsewave.dev/v1/api-keys"
payload := strings.NewReader("{\n \"name\": \"Production backend\",\n \"scopes\": [\n \"messages:write\",\n \"messages:read\"\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://api.pulsewave.dev/v1/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production backend\",\n \"scopes\": [\n \"messages:write\",\n \"messages:read\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pulsewave.dev/v1/api-keys")
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 \"name\": \"Production backend\",\n \"scopes\": [\n \"messages:write\",\n \"messages:read\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "key_4m8n2q",
"object": "api_key",
"name": "<string>",
"mode": "live",
"scopes": [
"<string>"
],
"last_used_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"secret": "pw_live_8f2k9q3m1n7r5t6y4u2i0o8p"
}{
"error": {
"type": "invalid_request",
"code": "missing_required_field",
"message": "The 'to' field is required for channel 'email'",
"param": "to"
}
}{
"error": {
"type": "invalid_request",
"code": "missing_required_field",
"message": "The 'to' field is required for channel 'email'",
"param": "to"
}
}API Keys
Create an API key
The full secret value is returned only once, in this response. Store it securely; Pulsewave cannot show it to you again.
POST
/
api-keys
Create an API key
curl --request POST \
--url https://api.pulsewave.dev/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Production backend",
"scopes": [
"messages:write",
"messages:read"
]
}
'import requests
url = "https://api.pulsewave.dev/v1/api-keys"
payload = {
"name": "Production backend",
"scopes": ["messages:write", "messages:read"]
}
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({name: 'Production backend', scopes: ['messages:write', 'messages:read']})
};
fetch('https://api.pulsewave.dev/v1/api-keys', 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.pulsewave.dev/v1/api-keys",
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' => 'Production backend',
'scopes' => [
'messages:write',
'messages:read'
]
]),
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.pulsewave.dev/v1/api-keys"
payload := strings.NewReader("{\n \"name\": \"Production backend\",\n \"scopes\": [\n \"messages:write\",\n \"messages:read\"\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://api.pulsewave.dev/v1/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production backend\",\n \"scopes\": [\n \"messages:write\",\n \"messages:read\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pulsewave.dev/v1/api-keys")
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 \"name\": \"Production backend\",\n \"scopes\": [\n \"messages:write\",\n \"messages:read\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "key_4m8n2q",
"object": "api_key",
"name": "<string>",
"mode": "live",
"scopes": [
"<string>"
],
"last_used_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"secret": "pw_live_8f2k9q3m1n7r5t6y4u2i0o8p"
}{
"error": {
"type": "invalid_request",
"code": "missing_required_field",
"message": "The 'to' field is required for channel 'email'",
"param": "to"
}
}{
"error": {
"type": "invalid_request",
"code": "missing_required_field",
"message": "The 'to' field is required for channel 'email'",
"param": "to"
}
}Authorizations
All requests must include Authorization: Bearer <api_key>. Keys are prefixed pw_live_ or pw_test_. See Authentication.
Body
application/json
Example:
"Production backend"
Test keys can only send to verified test addresses and never incur charges
Available options:
live, test Permissions granted to this key. Defaults to ["messages:write", "messages:read"].
Example:
["messages:write", "messages:read"]
Response
The created API key, including its one-time secret
Example:
"key_4m8n2q"
Available options:
api_key Test keys can only send to verified test addresses and never incur charges
Available options:
live, test The full secret key. Only returned once.
Example:
"pw_live_8f2k9q3m1n7r5t6y4u2i0o8p"