Class WebhookCreateParams
-
- All Implemented Interfaces:
-
io.imagekit.core.Params
public final class WebhookCreateParams implements Params
Creates a new webhook and returns the created object, including the generated signing
secret.ImageKit sends a
POSTrequest to the webhookendpointwhenever one of the subscribedeventsoccurs. Use thesecretto verify the signature of each request. Learn more about webhooks.You can create up to 3 webhooks per account.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classWebhookCreateParams.BuilderA builder for WebhookCreateParams.
public final classWebhookCreateParams.Body
-
Method Summary
Modifier and Type Method Description final Stringendpoint()The URL where ImageKit sends webhook events as POSTrequests.final List<WebhookEventType>events()The event types this webhook is subscribed to. final Optional<Boolean>enabled()Whether the webhook is enabled. final JsonField<String>_endpoint()Returns the raw JSON value of endpoint. final JsonField<List<WebhookEventType>>_events()Returns the raw JSON value of events. final JsonField<Boolean>_enabled()Returns the raw JSON value of enabled. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final WebhookCreateParams.BuildertoBuilder()final WebhookCreateParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static WebhookCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of WebhookCreateParams. -
-
Method Detail
-
endpoint
final String endpoint()
The URL where ImageKit sends webhook events as
POSTrequests. Must use thehttporhttpsprotocol, and must be unique across all webhooks for your account.
-
events
final List<WebhookEventType> events()
The event types this webhook is subscribed to. ImageKit sends a request to the
endpointonly for these events.
-
enabled
final Optional<Boolean> enabled()
Whether the webhook is enabled. When
false, ImageKit doesn't send any events to theendpoint.
-
_endpoint
final JsonField<String> _endpoint()
Returns the raw JSON value of endpoint.
Unlike endpoint, this method doesn't throw if the JSON field has an unexpected type.
-
_events
final JsonField<List<WebhookEventType>> _events()
Returns the raw JSON value of events.
Unlike events, this method doesn't throw if the JSON field has an unexpected type.
-
_enabled
final JsonField<Boolean> _enabled()
Returns the raw JSON value of enabled.
Unlike enabled, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final WebhookCreateParams.Builder toBuilder()
-
_body
final WebhookCreateParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static WebhookCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of WebhookCreateParams.
The following fields are required:
.endpoint() .events()
-
-
-
-