POST
/
v1
/
indexer
/
subscriptions
Create subscription
curl --request POST \
  --url https://api.withconvexity.com/v1/indexer/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network": "BASE",
  "contractAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "webhookUrl": "https://api.merchant.example/webhooks/indexer",
  "events": [
    "transfer",
    "mint"
  ]
}
'
{
  "status": true,
  "message": "Indexer subscription created",
  "data": {
    "id": "665f1a2b3c4d5e6f7a8b9c0d",
    "projectId": "proj_9f8e7d6c5b4a",
    "network": "BASE",
    "contractAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "webhookUrl": "https://api.merchant.example/webhooks/indexer",
    "events": [
      "transfer",
      "mint"
    ],
    "status": "active",
    "createdBy": "proj_9f8e7d6c5b4a",
    "createdAt": "2026-06-17T09:12:44.118Z",
    "updatedAt": "2026-06-17T09:12:44.118Z",
    "lastDeliveryAt": null,
    "deliveredCount": 0,
    "failedCount": 0,
    "signingSecret": "whsec_3f9b1c8a7d6e5f4039a2b1c0d9e8f7a6b5c4d3e2f1a0998877665544332211",
    "secretWarning": "Store this signing secret securely; it will not be shown again. Use it to verify the X-Indexer-Signature header."
  }
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 access token from Auth-Edge.

Body

application/json
​
network
enum<string>
required
Available options:
ATC,
BSC,
ETH,
BASE,
POL,
SOL,
LISK
​
contractAddress
string
required

Contract to watch (1–128 chars).

​
webhookUrl
string<uri>
required

HTTPS URL to deliver events to.

​
events
string[]

Catalog keys to subscribe to (each 1–64 chars).

Response

Created

The response is of type object.