Get all webhook subscriptions

Retrieve an array of existing permissionless webhook subscriptions.

GET /v2/notifications/subscriptions/permissionless

Get all webhook subscriptions

cURL

curl --request GET \
  --url https://api.circle.com/v2/notifications/subscriptions/permissionless \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.circle.com/v2/notifications/subscriptions/permissionless"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.circle.com/v2/notifications/subscriptions/permissionless")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "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": 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.

Query Parameters

environment · enum<string>

Filter subscriptions by environment. If omitted, returns subscriptions for all environments. The environment for the subscription. Use TEST to receive testnet events or LIVE to receive mainnet events.

Available options: TEST, LIVE

Example:

"TEST"

Response

200

application/json

Successfully retrieved webhook subscriptions.

data · PermissionlessSubscription · object[]

Show child attributes