Create a webhook subscription

Create a permissionless webhook subscription by configuring an endpoint to receive event notifications. Specify the environment, wallet addresses to monitor, blockchain domains to watch, and event types to receive.

POST /v2/notifications/subscriptions/permissionless

Create a webhook subscription

cURL

curl --request POST \
  --url https://api.circle.com/v2/notifications/subscriptions/permissionless \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "environment": "TEST",
  "endpoint": "https://example.org/handler/for/notifications",
  "addresses": [
    "0x1234567890abcdef1234567890abcdef12345678"
  ],
  "domains": [
    "26"
  ],
  "name": "Gateway Webhooks",
  "enabled": true,
  "notificationTypes": [
    "gateway.*"
  ]
}
'

import requests

url = "https://api.circle.com/v2/notifications/subscriptions/permissionless"

payload = {
    "environment": "TEST",
    "endpoint": "https://example.org/handler/for/notifications",
    "addresses": ["0x1234567890abcdef1234567890abcdef12345678"],
    "domains": ["26"],
    "name": "Gateway Webhooks",
    "enabled": True,
    "notificationTypes": ["gateway.*"]
}
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({
    environment: 'TEST',
    endpoint: 'https://example.org/handler/for/notifications',
    addresses: ['0x1234567890abcdef1234567890abcdef12345678'],
    domains: ['26'],
    name: 'Gateway Webhooks',
    enabled: true,
    notificationTypes: ['gateway.*']
  })
};

fetch('https://api.circle.com/v2/notifications/subscriptions/permissionless', 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.circle.com/v2/notifications/subscriptions/permissionless",
  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([
    'environment' => 'TEST',
    'endpoint' => 'https://example.org/handler/for/notifications',
    'addresses' => [
        '0x1234567890abcdef1234567890abcdef12345678'
    ],
    'domains' => [
        '26'
    ],
    'name' => 'Gateway Webhooks',
    'enabled' => true,
    'notificationTypes' => [
        'gateway.*'
    ]
  ]),
  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.circle.com/v2/notifications/subscriptions/permissionless"

	payload := strings.NewReader("{\n  \"environment\": \"TEST\",\n  \"endpoint\": \"https://example.org/handler/for/notifications\",\n  \"addresses\": [\n    \"0x1234567890abcdef1234567890abcdef12345678\"\n  ],\n  \"domains\": [\n    \"26\"\n  ],\n  \"name\": \"Gateway Webhooks\",\n  \"enabled\": true,\n  \"notificationTypes\": [\n    \"gateway.*\"\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.circle.com/v2/notifications/subscriptions/permissionless")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"environment\": \"TEST\",\n  \"endpoint\": \"https://example.org/handler/for/notifications\",\n  \"addresses\": [\n    \"0x1234567890abcdef1234567890abcdef12345678\"\n  ],\n  \"domains\": [\n    \"26\"\n  ],\n  \"name\": \"Gateway Webhooks\",\n  \"enabled\": true,\n  \"notificationTypes\": [\n    \"gateway.*\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.circle.com/v2/notifications/subscriptions/permissionless")

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  \"environment\": \"TEST\",\n  \"endpoint\": \"https://example.org/handler/for/notifications\",\n  \"addresses\": [\n    \"0x1234567890abcdef1234567890abcdef12345678\"\n  ],\n  \"domains\": [\n    \"26\"\n  ],\n  \"name\": \"Gateway Webhooks\",\n  \"enabled\": true,\n  \"notificationTypes\": [\n    \"gateway.*\"\n  ]\n}"

response = http.request(request)
puts response.read_body

201

{
  "data": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "endpoint": "https://example.org/handler/for/notifications",
    "enabled": true,
    "notificationTypes": [
      "gateway.*"
    ],
    "restricted": false,
    "addresses": [
      "0x1234567890abcdef1234567890abcdef12345678"
    ],
    "domains": [
      "26"
    ],
    "environment": "TEST",
    "createDate": "2023-01-01T12:04:05Z",
    "updateDate": "2023-01-01T12:04:05Z",
    "name": "Gateway Webhooks"
  }
}

{
  "code": 400,
  "message": "Bad request."
}

{
  "code": 401,
  "message": "Malformed authorization."
}

Authorizations

Authorization · string · header · required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are required to make a successful request.

Headers

X-Request-Id · string<uuid>

Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. Must be a UUID to appear in logs. Non-UUID values are accepted by the API but are ignored by logging and tracing systems.

A unique identifier, which can be helpful for identifying a request when communicating with Circle support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Body

application/json

Schema for the request payload to create a new subscription.

Required parameters to create a new subscription.

environment · enum<string> · required

The environment for the subscription. Use TEST to receive testnet events or LIVE to receive mainnet events.

Available options: TEST, LIVE

Example:

"TEST"

endpoint · string · required

URL of the endpoint to subscribe to notifications. Must be publicly accessible, use HTTPS, and respond with a 2XX status to a POST request.

Example:

"https://example.org/handler/for/notifications"

addresses · string[] · required

The EVM or Solana wallet addresses to monitor. Notifications fire only for events on these addresses.

Example:

[
  "0x1234567890abcdef1234567890abcdef12345678"
]

domains · string[] · required

The CCTP domain identifiers for the blockchains to watch.

Example:

["26"]

name · string

Name of the webhook notification subscription.

Example:

"Gateway Webhooks"

enabled · boolean · default: true

Whether the subscription is enabled. Defaults to true.

Example:

true

notificationTypes · enum<string>[]

The notification types to subscribe to. If omitted or if gateway.* is provided, the webhook is unrestricted for Gateway events and the response returns restricted: false. If individual event types are provided, the webhook is restricted to those event types.

Notification type for Gateway webhook subscriptions. Omit notificationTypes or use gateway.* to subscribe to all current and future Gateway notification types. Use individual event types to restrict delivery to specific Gateway events.

Available options: gateway.*, gateway.deposit.finalized, gateway.mint.finalized, gateway.mint.forwarded

Example:

["gateway.*"]

Response

201

application/json

Successfully created a webhook subscription.

data · PermissionlessSubscription · object

Contains information about a permissionless webhook notification subscription.

Show child attributes