User Profile Events Callback

When events occur on the User Profile, AiPrise sends a callback (a POST request) to the set events_callback_url

There are two ways to set the events_callback_url:

  1. Set the events_callback_url at the template level. This can be set from the Dashboard > View Templates > {TemplateID}.
  2. Set the events_callback_url URL with each create user profile request using the parameter events_callback_url.

📘

Note

In case events_callback_url is set in the create user profile request, it will take precedence over the one set at the template level.

Types of Events Callback

USER_PROFILE_CREATE

Payload:

KeyValue
user_profile_event_typeThe type of event callback. Here, it will beUSER_PROFILE_CREATE
user_profile_idThe ID associated with the user profile
author_idThe email of the User who created the profile or SOURCE_API if created via API Integration

USER_PROFILE_INFO_UPDATE

Payload:

KeyValue
user_profile_event_typeThe type of event callback. Here, it will beUSER_PROFILE_INFO_UPDATE
user_profile_idThe ID associated with the user profile
author_idThe email of the User who updated the profile or SOURCE_API if created via API Integration

RUN_USER_VERIFICATION

Payload:

KeyValue
user_profile_event_typeThe type of event callback. Here, it will beRUN_USER_VERIFICATION
user_profile_idThe ID associated with the user profile
***Additionally, all fields from
https://docs.aiprise.com/docs/verification-result-1

ADD_ADDITIONAL_MEDIA

Payload:

KeyValue
user_profile_event_typeThe type of event callback. Here, it will beADD_ADDITIONAL_MEDIA
user_profile_idThe ID associated with the user profile
file_uuidUnique ID associated with the added media

DELETE_ADDITIONAL_MEDIA

Payload:

KeyValue
user_profile_event_typeThe type of event callback. Here, it will beDELETE_ADDITIONAL_MEDIA
user_profile_idThe ID associated with the user profile
file_uuidUnique ID associated with the added media

COMMENT

Payload:

KeyValue
user_profile_event_typeThe type of event callback. Here, it will beCOMMENT
user_profile_idThe ID associated with the user profile
commentThe comment made by the user
authorInformation about the person that made the comment
author.email_addressEmail address of the person
author_idThe Email of the person who made the comment

RELATED_CASE_STATUS_UPDATE

Payload:

KeyValue
user_profile_event_typeThe type of event callback. Here, it will beRELATED_CASE_STATUS_UPDATE
user_profile_idThe ID associated with the user profile
author_idThe email of the User who updated the profile or SOURCE_API if created via API Integration

VERIFICATION_REQUEST_SUBMITTED

Payload:

KeyValue
user_profile_event_typeThe type of event callback. Here, it will beVERIFICATION_REQUEST_SUBMITTED
user_profile_idThe ID associated with the user profile
author_idThe email of the User who updated the profile or SOURCE_API if created via API Integration