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.
Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
      • POSTCounterparty Added
      • POSTCounterparty Hidden
      • POSTCounterparty Onboarding Completed
      • POSTEntity Created
      • POSTEntity Updated
      • POSTEntity Status Changed
      • POSTEntity Metadata Updated
      • POSTPayment Method Created
      • POSTPayment Method Updated
      • POSTPayment Method Deleted
      • POSTInvoice Created
      • POSTInvoice Updated
      • POSTInvoice Deleted
      • POSTInvoice Status Changed
      • POSTIncoming Invoice Email
      • POSTInvoice Status Draft
      • POSTInvoice Status New
      • POSTInvoice Status Approved
      • POSTInvoice Status Refused
      • POSTInvoice Status Scheduled
      • POSTInvoice Status Pending
      • POSTInvoice Status Canceled
      • POSTInvoice Status Paid
      • POSTInvoice Status Failed
      • POSTInvoice Status Archived
      • POSTTransaction Created
      • POSTTransaction Pending
      • POSTTransaction Completed
      • POSTTransaction Failed
      • POSTTransaction Returned
      • POSTBulk Invoices Created
      • POSTBulk Invoices Updated
      • POSTBulk Invoices Approved
      • POSTBulk Entities Created
      • POSTInvoice Collection Event - Overdue Invoice
      • POSTInvoice Collection Event - Email Sent
      • POSTInvoice Collection Event - Email Received
      • POSTOCR Job Completed
      • POSTPayment Gateway Validation Job Completed
      • POSTPayment Gateway Process Job Completed
Logo
Sign inBook a demo
API ReferenceWebhooks

Counterparty Added

Payload
1{
2  "eventType": "counterparty.added",
3  "payeeId": [
4    "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
5  ],
6  "payorId": [
7    "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c"
8  ],
9  "user": {
10    "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
11    "roles": [
12      "admin",
13      "approver"
14    ],
15    "createdAt": "2024-01-01T00:00:00Z",
16    "updatedAt": "2024-01-01T00:00:00Z",
17    "foreignId": "MY-DB-ID-12345",
18    "email": "john.doe@acme.com",
19    "name": "John Doe"
20  }
21}

A payee-payor relationship was created

Was this page helpful?
Previous

Counterparty Hidden

Next
Built with

Payload

The payload of this webhook request is an object.
eventTypestringRequired
The type of the event.
payeeIdlist of stringsRequired
A list of IDs for the payees involved.
payorIdlist of stringsRequired
A list of IDs for the payors involved.
userobjectOptional
User who initiated the change.

Response

200
any
Return a 200 status to indicate that the data was received successfully.