GRgreendot
Event

Configure Test Event Webhook Loopback Response

Sets the minimum and maximum delay, HTTP status code, response body, and content type for the test event webhook loopback endpoint.

post/programs/{programCode}/testeventwebhooksetconfig

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The program code from the route parameter.

Headers

X-GD-RequestIdstring required

The unique request identifier from the X-GD-RequestId header.

Request body

minimuminteger

Gets or sets the minimum amount of time (in milliseconds) to delay the webhook response. A value of 0 means no delay will be applied.

maximuminteger

Gets or sets the maximum amount of time (in milliseconds) to delay the webhook response. A value of 0 means no delay will be applied.

responseHttpStatusCode'Continue' | 'SwitchingProtocols' | 'Processing' | 'EarlyHints' | 'OK' | 'Created' | 'Accepted' | 'NonAuthoritativeInformation' | 'NoContent' | 'ResetContent' | 'PartialContent' | 'MultiStatus' | 'AlreadyReported' | 'IMUsed' | 'MultipleChoices' | 'MovedPermanently' | 'Found' | 'SeeOther' | 'NotModified' | 'UseProxy' | 'Unused' | 'RedirectKeepVerb' | 'PermanentRedirect' | 'BadRequest' | 'Unauthorized' | 'PaymentRequired' | 'Forbidden' | 'NotFound' | 'MethodNotAllowed' | 'NotAcceptable' | 'ProxyAuthenticationRequired' | 'RequestTimeout' | 'Conflict' | 'Gone' | 'LengthRequired' | 'PreconditionFailed' | 'RequestEntityTooLarge' | 'RequestUriTooLong' | 'UnsupportedMediaType' | 'RequestedRangeNotSatisfiable' | 'ExpectationFailed' | 'MisdirectedRequest' | 'UnprocessableEntity' | 'Locked' | 'FailedDependency' | 'UpgradeRequired' | 'PreconditionRequired' | 'TooManyRequests' | 'RequestHeaderFieldsTooLarge' | 'UnavailableForLegalReasons' | 'InternalServerError' | 'NotImplemented' | 'BadGateway' | 'ServiceUnavailable' | 'GatewayTimeout' | 'HttpVersionNotSupported' | 'VariantAlsoNegotiates' | 'InsufficientStorage' | 'LoopDetected' | 'NotExtended' | 'NetworkAuthenticationRequired' nullable

Gets or sets the HTTP status code to be returned in the simulated webhook response. If not provided, the default status code will be used.

responseBodystring nullable

Gets or sets the HTTP response body to be returned when Gd.Bos.DataTransfer.Request.TestEventWebHookSetConfigRequest.ResponseHttpStatusCode is provided. If null or empty, the response will not include a body.

responseContentTypestring nullable

Gets or sets the content type to return with the Gd.Bos.DataTransfer.Request.TestEventWebHookSetConfigRequest.ResponseHttpStatusCode. If null or empty, defaults to "application/json" or as determined by the server.

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.