Create a new webhook (POST)
Create a new webhook to receive notifications from the alumni platform.
Call
By using this API you will be able to configure how, when and where you want to receive information for updates from your Alumni Platform.
Fields
Description: The webhook's description is a string to summarize or describe what it does to better understand in the future.
Event Types: When the webhook will be triggered, in other words, what information is going to update it. The available types are:
- USER_CREATED
- USER_UPDATED
- USER_DELETED
- USER_EMAIL_CREATED
- USER_EMAIL_UPDATED
- USER_EMAIL_DELETED
- USER_EMAIL_USAGES_CREATED
- USER_EMAIL_USAGES_UPDATED
- USER_EMAIL_USAGES_DELETED
- EVENT_CREATED
- EVENT_UPDATED
- EVENT_DELETED
- USER_PREFERENCES_UPDATED
URL: This address is where the information is going to be sent.
CredentialGuid: The previously created webhook credential.
httpMethod: Which kind of method is going to be used in this webhook. (GET/POST/PUT/PATCH/DELETE).
resourceGuid: This field has been DEPRECATED and should not be used as a body parameter in this API.
Response
To understand each field that is available in the webhook payload, the best way to do so is to go to the field manager and look at all the field’s field key in order to associate each field from the UI to the fields available in the payload, however, there are some fields that their field keys are not available in the UI but are used by users, these are:
· scnId: This field corresponds to the user’s membership number (the one used for the Alumni Identification card). · Internal: Whether the user is internal or not · idpProvisionType: This is for EnterpriseAlumni’s internal use related to the IDP (Okta or SAP). · userType: The type of user (usually USER or SUBSCRIBER).
Any other field that might be unrecognized at first sight, is a field used internally and available in the database.
Please see the payload for each event type.
API URL:
https://gateway.enterprisealumni.com/api/v2/webhook
*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.
Updated 19 days ago