Webhooks
✅ Validado (off-chain / infra)
Suite misc-infra — CRUD + deliveries validados (61/61 off-chain).
Gerada automaticamente do spec OpenAPI da API (fonte de verdade). 7 endpoint(s).
List endpoints
GET /v1/webhook_endpoints
List all webhook endpoints
Auth: api-key
Respostas: 200, 401
Create endpoint
POST /v1/webhook_endpoints
Create a new webhook endpoint to receive event notifications
Auth: api-key
Request body:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
url | string (uri) | sim | |
events | token.deployed | token.paused | token.unpaused | token.minted | token.burned | token.transferred | token.approved | transaction.confirmed | transaction.failed | wallet.created | token.frozen | token.unfrozen | token.force_transferred | token.recovered | nft.minted | nft.transferred | nft.burned | nft.metadata_updated | identity.registered | identity.removed | identity.updated | identity.country.updated | identity.claim.added | identity.claim.removed | compliance.module.deployed | compliance.module.removed | compliance.rule.added | compliance.token.bound | compliance.token.unbound | trusted_issuer.registered | trusted_issuer.removed | trusted_issuer.claim_topics.updated | claim_topic.registered | claim_topic.removed | governance.deployed | governance.proposal.created | governance.vote.cast | governance.proposal.queued | governance.proposal.executed | governance.proposal.canceled | governance.delegated | role.granted | role.revoked | vesting.deployed | vesting.released | vault.deployed | vault.deposit | vault.withdraw | vault.redeem | vault.mint | api_key.created | api_key.revoked | api_key.rotated | auth.registered | auth.login | sim | |
description | string | não | |
metadata | object | não | Stripe-style metadata: arbitrary key-value store (max 50 keys, values up to 500 chars). Used by dev to attach external IDs, environment tags, integration context. |
Respostas: 201, 400, 401
Retrieve endpoint
GET /v1/webhook_endpoints/{id}
Retrieve a webhook endpoint by ID
Auth: api-key
Path params: id
Respostas: 200, 401, 404
Update endpoint
POST /v1/webhook_endpoints/{id}
Update a webhook endpoint (url, events, description, metadata) — Stripe-style POST.
Auth: api-key
Path params: id
Request body:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
url | string (uri) | não | |
events | token.deployed | token.paused | token.unpaused | token.minted | token.burned | token.transferred | token.approved | transaction.confirmed | transaction.failed | wallet.created | token.frozen | token.unfrozen | token.force_transferred | token.recovered | nft.minted | nft.transferred | nft.burned | nft.metadata_updated | identity.registered | identity.removed | identity.updated | identity.country.updated | identity.claim.added | identity.claim.removed | compliance.module.deployed | compliance.module.removed | compliance.rule.added | compliance.token.bound | compliance.token.unbound | trusted_issuer.registered | trusted_issuer.removed | trusted_issuer.claim_topics.updated | claim_topic.registered | claim_topic.removed | governance.deployed | governance.proposal.created | governance.vote.cast | governance.proposal.queued | governance.proposal.executed | governance.proposal.canceled | governance.delegated | role.granted | role.revoked | vesting.deployed | vesting.released | vault.deployed | vault.deposit | vault.withdraw | vault.redeem | vault.mint | api_key.created | api_key.revoked | api_key.rotated | auth.registered | auth.login | não | |
description | string | não | |
metadata | object | não |
Respostas: 200, 201, 400, 401, 404
Update endpoint (PUT — legacy)
PUT /v1/webhook_endpoints/{id}
DEPRECATED. Use POST /v1/webhook_endpoints/:id (Stripe convention).
Auth: api-key
Path params: id
Request body:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
url | string (uri) | não | |
events | token.deployed | token.paused | token.unpaused | token.minted | token.burned | token.transferred | token.approved | transaction.confirmed | transaction.failed | wallet.created | token.frozen | token.unfrozen | token.force_transferred | token.recovered | nft.minted | nft.transferred | nft.burned | nft.metadata_updated | identity.registered | identity.removed | identity.updated | identity.country.updated | identity.claim.added | identity.claim.removed | compliance.module.deployed | compliance.module.removed | compliance.rule.added | compliance.token.bound | compliance.token.unbound | trusted_issuer.registered | trusted_issuer.removed | trusted_issuer.claim_topics.updated | claim_topic.registered | claim_topic.removed | governance.deployed | governance.proposal.created | governance.vote.cast | governance.proposal.queued | governance.proposal.executed | governance.proposal.canceled | governance.delegated | role.granted | role.revoked | vesting.deployed | vesting.released | vault.deployed | vault.deposit | vault.withdraw | vault.redeem | vault.mint | api_key.created | api_key.revoked | api_key.rotated | auth.registered | auth.login | não | |
description | string | não | |
metadata | object | não |
Respostas: 200, 400, 401, 404
Delete endpoint
DELETE /v1/webhook_endpoints/{id}
Delete a webhook endpoint
Auth: api-key
Path params: id
Respostas: 200, 401, 404
List deliveries
GET /v1/webhook_endpoints/{id}/deliveries
List webhook deliveries for an endpoint with filtering and pagination
Auth: api-key
Path params: id
Query params:
| Param | Tipo | Obrigatório |
|---|---|---|
status | string | não |
limit | string | não |
starting_after | string | não |
Respostas: 200, 401, 404