Update a webhook credential by resourceGuid (PUT)

The purpose of this API is to update the webhook credential details by its ID.

Call

The API should be called when it is needed to update a webhook credential.

Fields

Even though some fields might not change it is required to send them again on the update.

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 webhook credential description, resourceGuid and authentication type.

Example:

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

API URL:

https://gateway.enterprisealumni.com/api/v2/credential/{resourceGuid}

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