public class RegisterCallbackOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
RegisterCallbackOptions.Builder
Builder.
|
Modifier and Type | Method and Description |
---|---|
String |
callbackUrl()
Gets the callbackUrl.
|
RegisterCallbackOptions.Builder |
newBuilder()
New builder.
|
String |
userSecret()
Gets the userSecret.
|
public RegisterCallbackOptions.Builder newBuilder()
public String callbackUrl()
An HTTP or HTTPS URL to which callback notifications are to be sent. To be allowlisted, the URL must successfully echo the challenge string during URL verification. During verification, the client can also check the signature that the service sends in the `X-Callback-Signature` header to verify the origin of the request.
public String userSecret()
A user-specified string that the service uses to generate the HMAC-SHA1 signature that it sends via the `X-Callback-Signature` header. The service includes the header during URL verification and with every notification sent to the callback URL. It calculates the signature over the payload of the notification. If you omit the parameter, the service does not send the header.
Copyright © 2023 IBM Cloud. All rights reserved.