Create a webhook endpoint

curl --request POST \
  --url https://api.0xarchive.io/v1/webhooks/endpoints \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "https://example.com/hooks/0xarchive"
}
'

import requests

url = "https://api.0xarchive.io/v1/webhooks/endpoints"

payload = { "url": "https://example.com/hooks/0xarchive" }
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://example.com/hooks/0xarchive'})
};

fetch('https://api.0xarchive.io/v1/webhooks/endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.0xarchive.io/v1/webhooks/endpoints"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/hooks/0xarchive\"\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))

}

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "https://example.com/hooks/0xarchive",
    "description": "Trading desk alerts",
    "status": "active",
    "consecutive_failures": 0,
    "created_at": "2023-11-07T05:31:56Z",
    "secret": "whsec_6f1c0b2a4d8e5f3a9c7b1e0d2f4a6c8b1d3e5f7a9c0b2d4e6f8a1c3b5d7e9f0a"
  },
  "note": "Store the secret now; it is not shown again."
}

{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

{
  "code": 429,
  "error": "Rate limit exceeded"
}

POST

https://api.0xarchive.io

webhooks

endpoints

Create a webhook endpoint

curl --request POST \
  --url https://api.0xarchive.io/v1/webhooks/endpoints \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "https://example.com/hooks/0xarchive"
}
'

import requests

url = "https://api.0xarchive.io/v1/webhooks/endpoints"

payload = { "url": "https://example.com/hooks/0xarchive" }
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://example.com/hooks/0xarchive'})
};

fetch('https://api.0xarchive.io/v1/webhooks/endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.0xarchive.io/v1/webhooks/endpoints"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/hooks/0xarchive\"\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))

}

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "https://example.com/hooks/0xarchive",
    "description": "Trading desk alerts",
    "status": "active",
    "consecutive_failures": 0,
    "created_at": "2023-11-07T05:31:56Z",
    "secret": "whsec_6f1c0b2a4d8e5f3a9c7b1e0d2f4a6c8b1d3e5f7a9c0b2d4e6f8a1c3b5d7e9f0a"
  },
  "note": "Store the secret now; it is not shown again."
}

{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

{
  "code": 429,
  "error": "Rate limit exceeded"
}

API key required. Send X-API-Key with this request. See REST authentication.

Shared request rules

Machine schema

Open the generated operation schema for machine-readable request and response details.

Authorizations

X-API-Key

string

header

required

API key for authentication. Get yours at https://0xarchive.io/dashboard

Body

application/json

A new delivery destination.

url

string<uri>

required

HTTPS destination that will receive deliveries. Destinations that resolve to a private or internal address are refused.

Example:

"https://example.com/hooks/0xarchive"

description

string

default:""

Your own label for the endpoint.

Example:

"Trading desk alerts"

Response

The new endpoint and its signing secret

API response containing a newly created endpoint and its signing secret.

success

boolean

Example:

true

data

object

A newly created endpoint, including the signing secret. This is one of the two responses that carry the secret; the other is a rotation. Store it now, because it is not shown again.

Hide child attributes

data.id

string<uuid>

required

Endpoint identifier.

data.url

string<uri>

required

HTTPS destination that receives deliveries.

Example:

"https://example.com/hooks/0xarchive"

data.description

string

required

Your own label for the endpoint.

Example:

"Trading desk alerts"

data.status

enum<string>

required

active is serving. disabled means you switched it off. auto_disabled means a long run of failed deliveries switched it off for you; bring it back with the enable route.

Available options:

active,

disabled,

auto_disabled

Example:

"active"

data.consecutive_failures

integer<int32>

required

Failed attempts since the last success. Resets to zero on a delivery that lands.

Example:

0

data.created_at

string<date-time>

required

When the endpoint was created.

data.secret

string

required

Signing secret for this endpoint. Every delivery is signed with it, and your receiver verifies the signature against it.

Example:

"whsec_6f1c0b2a4d8e5f3a9c7b1e0d2f4a6c8b1d3e5f7a9c0b2d4e6f8a1c3b5d7e9f0a"

note

string

That the secret is shown once.

Example:

"Store the secret now; it is not shown again."

Last modified on September 20, 2026

API reference

SDKs & tooling

AI & agents

Create a webhook endpoint

Authorizations

Body

Response