Counterparty Added

A payee-payor relationship was created

Payload

The payload of this webhook request is an object.

eventTypestringRequired

payeeIdlist of stringsRequired

payorIdlist of stringsRequired

userobjectOptional

User who initiated the change.

Response

200

any

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

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 }

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 }

Built with

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	}