For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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
      • POSTCreate a webhook
      • GETRetrieve a webhook
      • GETList all webhooks
      • PATCHUpdate a webhook
      • DELDelete a webhook
LogoLogo
Legacy DocsSign in
API ReferenceWebhooks

Create a webhook

POST
https://api.ntropy.com/v3/webhooks
POST
/v3/webhooks
$curl -X "POST" \
>    "https://api.ntropy.com/v3/webhooks" \
>    -H "Accept: application/json" \
>    -H "X-API-KEY: cd1H...Wmhl"  \
>    -H "Content-Type: application/json" \
>    -d '{
>        "url": "https://example.com:5689/",
>        "events": [
>            "batches.completed",
>            "batches.error"
>        ],
>        "token": "hunter2"
>    }'
$ 
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:30.167953",
9  "enabled": true,
10  "token": "hunter2"
11}

Create a webhook to be called when certain events occur.

Complete guide: Webhooks.

Was this page helpful?
Previous

Retrieve a webhook

Next
Built with

Authentication

X-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"1-1024 characters
The URL of the webhook
eventslist of enumsRequired
A list of events that this webhook subscribes to
tokenstring or nullOptional<=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

Response

Successful Response
urlstringformat: "uri"1-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

422
Unprocessable Entity Error