Skip to main content
POST
/
webhooks
/
{id}
/
ping
Ping webhook
curl --request POST \
  --url https://api.sandbox.iron.xyz/api/webhooks/{id}/ping \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
import requests

url = "https://api.sandbox.iron.xyz/api/webhooks/{id}/ping"

payload = { "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
"IDEMPOTENCY-KEY": "<idempotency-key>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json; charset=utf-8"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'IDEMPOTENCY-KEY': '<idempotency-key>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json; charset=utf-8'
},
body: JSON.stringify({customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.sandbox.iron.xyz/api/webhooks/{id}/ping', 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.sandbox.iron.xyz/api/webhooks/{id}/ping",
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([
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json; charset=utf-8",
"IDEMPOTENCY-KEY: <idempotency-key>",
"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.sandbox.iron.xyz/api/webhooks/{id}/ping"

payload := strings.NewReader("{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

req.Header.Add("IDEMPOTENCY-KEY", "<idempotency-key>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json; charset=utf-8")

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.sandbox.iron.xyz/api/webhooks/{id}/ping")
.header("IDEMPOTENCY-KEY", "<idempotency-key>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json; charset=utf-8")
.body("{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/webhooks/{id}/ping")

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

request = Net::HTTP::Post.new(url)
request["IDEMPOTENCY-KEY"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json; charset=utf-8'
request.body = "{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body
true
"<string>"
"<string>"
{
"message": "<string>",
"trace_id": "<string>"
}

Authorizations

X-API-Key
string
header
required

API Key

Headers

IDEMPOTENCY-KEY
string
required

a UUID ensuring the ping operation is only processed once

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the webhook will be pinged under scope of the sub-partner

Path Parameters

id
string<uuid>
required

the ID of the webhook to ping

Body

application/json; charset=utf-8

Parameters required to ping a webhook

customer_id
string<uuid>
required

Customer ID to use for the webhook ping

Response

Successfully pinged webhook

The response is of type boolean.