Orgs and Users

External Organizations Resource Events

The following events are supported by the Webhook API for the External Organizations resource:

Event	Description	Support
Create	When an external organization is created.	Smart Client
Update	When an update is made to an external organization.	Smart Client

External Users Resource Events

The following events are supported by the Webhook API for the External Users resource:

Event	Description	Support
Create	When an external user is created.	Smart Client, API
Update	When an update is made to an external user.	Smart Client, API
Delete	When an external user is deleted.	Smart Client, API

Internal Users Resource Events

The following events are supported by the Webhook API for the Internal Users resource:


Create	When a new internal user is created.	Smart Client, API
Update	When the user profile for an internal user is updated.	Smart Client, API
Delete	When an internal user is deleted.	Smart Client, API

User Groups Resource Events

Lenders can subscribe to the userGroups resource to be notified when a user group has been created, updated or deleted. The following events are supported by the Webhook API for the userGroups resource:

Event	Description	Support
Create	A user group has been created.	Smart Client
Update	A user group has been updated (e.g., member added, removed, updated).	Smart Client
Delete	A user group has been deleted.	Smart Client

Notification Message

When a subscription is registered, the client application issues a POST notification to the callback URL (endpoint) you defined in the webhook. The notification is sent as JSON in the POST request body.

{ 
  "eventId": "ff430730-dd08-418d-9488-6c55d9a5fabb", 
  "eventTime": "2023-09-12T05:26:04.200Z", 
  "eventType": "update", 
  "meta": { 
    "userId": "admin", 
    "resourceType": "InternalUsers", 
    "resourceId": "e107a22f-e78b-43b8-821d-c8ba47c21ba2", 
    "instanceId": "debe11231313", 
    "resourceRef": "/encompass/v3/users", 
    "payload": { 
      "entities": [ 
        { 
          "id": "admin" 
        } 
      ] 
    } 
  } 
}

{ 
  "eventId": "b7cb3e9c-2481-4c9c-af90-55a5d1b6a693", 
  "eventTime": "2023-09-11T23:14:50.059Z", 
  "eventType": "delete", 
  "meta": { 
    "userId": "admin", 
    "resourceType": "ExternalUsers", 
    "resourceId": "423253b1-cd23-4424-b6e8-204dfce2751e", 
    "instanceId": "debe11231313", 
    "resourceRef": "/encompass/v3/externalUsers", 
    "payload": { 
      "entities": [ 
        { 
          "id": "5087389457" 
        } 
      ] 
    } 
  } 
}

{ 
  "eventId": "8277a8a8-a8d7-4214-821a-781951d4ea56", 
  "eventTime": "2023-09-11T22:56:45.068Z", 
  "eventType": "create", 
  "meta": { 
    "userId": "admin", 
    "resourceType": "InternalUsers", 
    "resourceId": "979760d5-9377-4da7-99df-30eb666d925f", 
    "instanceId": "debe11231313", 
    "resourceRef": "/encompass/v3/users", 
    "payload": { 
      "entities": [ 
        { 
          "id": "salesrep" 
        } 
      ] 
    } 
  } 
}

{ 
    "createdDate": "2021-05-05T13:12:48Z", 
    "envelopeVersion": "2.0.0", 
    "payloadVersion": "2.0.0", 
    "id": "92d6d9d5-5aec-4bc0-a8cf-2019f945032d", 
    "correlationId": "1e929f32-7c26-4350-88e8-504bb94501f4", 
    "category": "event", 
    "source": "urn:elli:service:ebs", 
    "type": "urn:elli:service:ebs:usergroup:change", // or urn:elli:service:encompass:documentGroup:change, 
    "tenant": "urn:elli:encompass:BE11174493:user:admin", 
    "entityId": "3d7ee116-ec80-4dbf-b387-14606d0e4804", 
    "payload": { 
        "userId": "admin", 
        "eventType": "create",                           // create | update | delete 
        "resource": { 
            "type": "userGroups", 
            "reference": "/encompass/v3/groups/33", 
            "id": "3d7ee116-ec80-4dbf-b387-14606d0e4804" 
        }, 
        "client": { 
            "instanceId": "BE11174493", 
            "clientId": "3010000024" 
        }, 
        "event": { 
            "Action":"Add/Update/Unassign", 
            "Members": [                 
                { 
                    "entityId": "12", 
                    "entityName": "Processors", 
                    "entityType": "Organization" 
                }, 
                { 
                    "entityId": "13", 
                    "entityName": "Branch 1 Personnel", 
                    "entityType": "Organization" 
                }, 
                { 
                    "entityId": "17", 
                    "entityName": "Underwriters", 
                    "entityType": "Organization" 
                }             
            ] 
        } 
    } 
}

Back to Webhooks Overview