Start here
Registered endpoints and how they are doing
GET
/v1/webhookson https://api.auray.ai/v1Registered endpoints and how they are doing
#Authentication
Authorization: Bearer auray_sk_… — jobs:read — reading is reading.
#Example request
curl https://api.auray.ai/v1/webhooks \
-H "Authorization: Bearer $AURAY_API_KEY"import { createClient } from "@auray/client";
const auray = createClient(); // reads AURAY_API_KEY
console.log(await auray.platform.webhooks.list());from auray_client import Client
auray = Client() # reads AURAY_API_KEY
print(auray.platform.webhooks.list())const res = await fetch("https://api.auray.ai/v1/webhooks", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.AURAY_API_KEY}` },
});
console.log(await res.json());import os, requests
r = requests.get(
"https://api.auray.ai/v1/webhooks",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
)
r.raise_for_status()
print(r.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://api.auray.ai/v1/webhooks", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("AURAY_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}<?php
$ch = curl_init("https://api.auray.ai/v1/webhooks");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("AURAY_API_KEY"),
],
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
uri = URI("https://api.auray.ai/v1/webhooks")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, res.bodyimport java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.auray.ai/v1/webhooks"))
.header("Authorization", "Bearer " + System.getenv("AURAY_API_KEY"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AURAY_API_KEY"));
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.auray.ai/v1/webhooks");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");#Responses
#200 OK
OK
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
object | string | no | — | |
data | object[] | no | — | |
data[].id | string | no | — | |
data[].object | string | no | — | One of "webhook". |
data[].url | string | no | — | A URL. |
data[].products | string[] | no | — | |
data[].status | string | no | — | One of "pending", "active", "disabled", "dead". |
data[].consecutive_failures | integer | no | — | |
data[].last_status_code | integer | no | — | May be null. |
data[].disabled_reason | string | no | — | May be null. |
data[].created_at | string | no | — | |
data[].verified_at | string | no | — | When the endpoint answered its challenge. Null before it has — and null again if the same URL is re-registered, which resets the endpoint rather than adding a second one. May be null. |
data[].last_success_at | string | no | — | When a delivery to this endpoint last succeeded. May be null. |
data[].last_failure_at | string | no | — | When one last failed. May be null. |
Headers:
| Header | Description |
|---|---|
RateLimit-Limit | Burst capacity. |
RateLimit-Remaining | |
RateLimit-Reset | Seconds until refill. |
X-RateLimit-Limit | |
X-RateLimit-Remaining | |
X-RateLimit-Reset | Unix seconds. The X- spelling is what client libraries read. |
X-Request-Id |
#401 Unauthorized
#403 Forbidden
#429 Too Many Requests
#500 Internal Server Error
profile_read_failed — your endpoints could not be read. An empty list means you have none, never that we could not tell.
The error body: error, message, docs (the entry that explains it) and request_id.
#503 Service Unavailable
#Status codes
| Status | Meaning |
|---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
429 | Too Many Requests |
500 | profile_read_failed — your endpoints could not be read. |
503 | Service Unavailable |
Every refusal names its code, and every code is explained at Errors.