Create a new webhook credential (POST)

Call

This endpoint is part of the webhook configuration. Once a credential is defined, this credential can be used on the webhook configuration.

Fields

Description (description): a description that will help you to identify the credential from a list of credentials you might have. (required)

Authentication type (authType): BASIC / TOKEN / API Key (required)

Authentication data (authData): username / password/ token /apiKey (required)

Add the authentication data according to the selected authType.

resourceGuid: this field has been DEPRECATED and should not be used as a body parameter in this API.

Response:

When successfully executed, this API will return the defined description, authentication type and the webhook credential resourceGuid.

Example:

{
  "resourceGuid": "f79285ef-4ed1-4737-bcc5-998d861b9db4",
  "description": "Webhook credential for user updates",
  "authType": "BASIC"
}

API URL:

https://gateway.alumni-stage.com/api/v2/credential

*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.