🚀 We have launched a new version of the API. Read more about it in the changelog. 🚀

Legacy DocsSign in
DocumentationChangelog
DocumentationChangelog
  • Get Started
    • Introduction
    • Get your API keys
    • Support
    • Privacy policy
    • Status
  • Transaction Enrichment
    • Overview
    • Entities Identification
    • Categorization
    • Recurrence
  • Bank Statements
    • Overview
    • Fast verification
  • Core resources
    • Batches
    • Entities
    • Account Holders
    • Webhooks
    • Personalization
    • Reporting wrong results
  • API Reference
    • Authentication
    • Errors
    • Request IDs
    • Pagination
    • Rate limits
LogoLogo
Legacy DocsSign in
API ReferenceWebhooks

GET
https://api.ntropy.com/v3/webhooks/:id
GET
/v3/webhooks/:id
1curl -X "GET" \
2    "https://api.ntropy.com/v3/webhooks/e94a150d-40af-4e96-8aa7-2948a6b4d8d3" \
3    -H "Accept: application/json" \
4    -H "X-API-KEY: cd1H...Wmhl"
Try it
1{
2  "url": "https://example.com:5689",
3  "events": [
4    "batches.completed",
5    "batches.error"
6  ],
7  "id": "e94a150d-40af-4e96-8aa7-2948a6b4d8d3",
8  "created_at": "2024-10-03T02:53:30Z",
9  "enabled": true,
10  "token": "hunter2"
11}
Was this page helpful?
Previous

List all webhooks

Next
Built with
Retrieve a webhook
Retrieve a webhook

Authentication

X-Api-Keystring
API Key authentication via header

Path Parameters

idstringRequired

Response

Successful Response
urlstringformat: "uri">=1 character<=1024 characters
The URL of the webhook
eventslist of enums
A list of events that this webhook subscribes to
idstring
A generated unique identifier for the webhook
created_atdatetime
The date and time when the webhook was created.
enabledboolean
Whether the webhook is enabled or not.
tokenstring or null<=128 characters

A secret string used to authenticate the webhook. This value will be included in the X-Ntropy-Token header when sending requests to the webhook

Errors