Skip to main content
GET
/
webhook
/
{identifier}
Get webhook by ID
curl --request GET \
  --url https://api.sendx.io/api/v1/rest/webhook/{identifier} \
  --header 'X-Team-ApiKey: <api-key>'
import requests

url = "https://api.sendx.io/api/v1/rest/webhook/{identifier}"

headers = {"X-Team-ApiKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-Team-ApiKey': '<api-key>'}};

fetch('https://api.sendx.io/api/v1/rest/webhook/{identifier}', 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.sendx.io/api/v1/rest/webhook/{identifier}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Team-ApiKey: <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"
"net/http"
"io"
)

func main() {

url := "https://api.sendx.io/api/v1/rest/webhook/{identifier}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-Team-ApiKey", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.sendx.io/api/v1/rest/webhook/{identifier}")
.header("X-Team-ApiKey", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sendx.io/api/v1/rest/webhook/{identifier}")

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

request = Net::HTTP::Get.new(url)
request["X-Team-ApiKey"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "webhook_9l154iiXlZoPo7vngmamee",
  "enabled": true,
  "url": "https://api.example.com/webhooks/sendx",
  "unsubscribed": true,
  "dropped": true,
  "bounced": true,
  "markedSpam": true,
  "clicked": true,
  "opened": true,
  "contactCreated": true,
  "created": 1705750200
}
{
"status": 401,
"message": "The Team ID or API Key specified is not valid"
}
{
"status": "error",
"message": "Resource not found"
}
{
"status": "error",
"message": "Request body is not in proper format"
}
{
"status": "error",
"message": "Internal server error occurred"
}

Authorizations

X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

X-Team-ApiKey: your_team_api_key_here

Path Parameters

identifier
string
required

Webhook identifier to retrieve

Pattern: ^(webhook_)?[a-zA-Z0-9]{22}$

Response

✅ Webhook retrieved successfully

id
string
Example:

"webhook_9l154iiXlZoPo7vngmamee"

url
string<uri>

Webhook endpoint URL

Example:

"https://api.example.com/webhooks/sendx"

enabled
boolean
default:true

Whether webhook is enabled

unsubscribed
boolean
default:false

Trigger webhook when a contact unsubscribes

dropped
boolean
default:false

Trigger webhook when an email is dropped

bounced
boolean
default:false

Trigger webhook when an email bounces

markedSpam
boolean
default:false

Trigger webhook when an email is marked as spam

clicked
boolean
default:false

Trigger webhook when a link in the email is clicked

opened
boolean
default:false

Trigger webhook when an email is opened

contactCreated
boolean
default:false

Trigger webhook when a new contact is created