Entity Created

Payload

1 {
2   "eventType": "entity.created",
3   "entity": {
4     "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
5     "name": "Acme Inc.",
6     "email": "customer@acme.com",
7     "isCustomer": true,
8     "accountType": "business",
9     "profile": {
10       "business": {
11         "legalBusinessName": "Acme Inc.",
12         "taxIDProvided": true,
13         "email": "customer@acme.com",
14         "businessType": "llc",
15         "phone": {
16           "countryCode": "1",
17           "number": "4155551234"
18         },
19         "address": {
20           "addressLine1": "123 Main St",
21           "city": "San Francisco",
22           "stateOrProvince": "CA",
23           "postalCode": "94105",
24           "addressLine2": "Unit 1",
25           "country": "US"
26         },
27         "ownersProvided": true,
28         "taxId": {
29           "ein": {
30             "number": "12-3456789"
31           }
32         }
33       }
34     },
35     "status": "verified",
36     "acceptedTos": true,
37     "isPayor": true,
38     "isPayee": false,
39     "isNetworkPayor": false,
40     "isNetworkPayee": false,
41     "createdAt": "2024-01-01T00:00:00Z",
42     "updatedAt": "2024-01-02T00:00:00Z",
43     "foreignId": "MY-DB-ID-12345"
44   },
45   "updatedByEntityId": "admin",
46   "user": {
47     "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
48     "roles": [
49       "admin",
50       "approver"
51     ],
52     "createdAt": "2024-01-01T00:00:00Z",
53     "updatedAt": "2024-01-01T00:00:00Z",
54     "foreignId": "MY-DB-ID-12345",
55     "email": "john.doe@acme.com",
56     "name": "John Doe"
57   }
58 }

A new entity was created

Payload

The payload of this webhook request is an object.

eventTypestringRequired

The type of the event.

entityobjectRequired

The entity involved in the event.

updatedByEntityIdstringRequired

The ID of the entity that updated the entity. This will be different from the entityId if the entity was updated by a different entity (e.g. a C2 updating a C3). If the entity was created or updated by an admin, this will be ‘admin’.

userobjectOptional

User who initiated the change.

Response

200

any

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