Class Webhook
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classWebhook.BuilderA builder for Webhook.
-
Method Summary
Modifier and Type Method Description final Stringid()Unique identifier for a webhook. final OffsetDateTimecreatedAt()ISO 8601 timestamp of when the webhook was created. final Booleanenabled()Whether the webhook is enabled. final Stringendpoint()The URL where ImageKit sends webhook events as POSTrequests.final List<WebhookEventType>events()The event types this webhook is subscribed to. final Stringsecret()Signing secret generated by ImageKit, used to verify that webhook requests come from ImageKit. final OffsetDateTimeupdatedAt()ISO 8601 timestamp of when the webhook was last updated. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<OffsetDateTime>_createdAt()Returns the raw JSON value of createdAt. final JsonField<Boolean>_enabled()Returns the raw JSON value of 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<String>_secret()Returns the raw JSON value of secret. final JsonField<OffsetDateTime>_updatedAt()Returns the raw JSON value of updatedAt. final Map<String, JsonValue>_additionalProperties()final Webhook.BuildertoBuilder()final Webhookvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Webhook.Builderbuilder()Returns a mutable builder for constructing an instance of Webhook. -
-
Method Detail
-
createdAt
final OffsetDateTime createdAt()
ISO 8601 timestamp of when the webhook was created.
-
enabled
final Boolean enabled()
Whether the webhook is enabled. When
false, ImageKit doesn't send any events to theendpoint.
-
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.
-
secret
final String secret()
Signing secret generated by ImageKit, used to verify that webhook requests come from ImageKit. Starts with
whsec_. This value can't be set or changed through the API. Learn more about verifying webhook signatures.
-
updatedAt
final OffsetDateTime updatedAt()
ISO 8601 timestamp of when the webhook was last updated.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<OffsetDateTime> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, 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.
-
_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.
-
_secret
final JsonField<String> _secret()
Returns the raw JSON value of secret.
Unlike secret, this method doesn't throw if the JSON field has an unexpected type.
-
_updatedAt
final JsonField<OffsetDateTime> _updatedAt()
Returns the raw JSON value of updatedAt.
Unlike updatedAt, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final Webhook.Builder toBuilder()
-
validate
final Webhook validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static Webhook.Builder builder()
Returns a mutable builder for constructing an instance of Webhook.
The following fields are required:
.id() .createdAt() .enabled() .endpoint() .events() .secret() .updatedAt()
-
-
-
-