ApiWebhooks class
Since v0.6
See https://uploadcare.com/api-refs/rest-api/v0.6.0/#tag/Webhook
Constructors
- ApiWebhooks({required ClientOptions options})
Properties
- apiUrl → String
-
no setterinherited
- cdnUrl → String
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- options → ClientOptions
-
final
- privateKey → String?
-
no setterinherited
- publicKey → String
-
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- uploadUrl → String
-
no setterinherited
- useAgent → String
-
no setterinherited
Methods
-
buildUri(
String url, [Map< String, dynamic> params = const {}]) → Uri -
inherited
-
create(
{required String targetUrl, required WebhookEvent event, bool? isActive, String? signingSecret, String? version}) → Future< WebhookEntity> - Create and subscribe to a webhook. You can use webhooks to receive notifications about your uploads. For instance, once a file gets uploaded to your project, we can notify you by sending a message to a target URL
-
createMultipartRequest(
String method, Uri uri, [bool authorizeRequest = true]) → UcMultipartRequest -
inherited
-
createRequest(
String method, Uri uri, [bool authorizeRequest = true]) → UcRequest -
inherited
-
delete(
String targetUrl) → Future< void> - Unsubscribe and delete a webhook
-
ensureRightVersion(
double expectedVersion, String prefix, {bool? exact}) → void -
inherited
-
list(
) → Future< List< WebhookEntity> > - List of project webhooks
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resolveStoreModeParam(
bool? storeMode) → String -
inherited
-
resolveStreamedResponse(
FutureOr< StreamedResponse> streamedResponse) → Future -
inherited
-
resolveStreamedResponseStatusCode(
FutureOr< StreamedResponse> streamedResponse) → Future<Response> -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
{required String hookId, String? targetUrl, WebhookEvent? event, bool? isActive, String? signingSecret}) → Future< WebhookEntity> - Update webhook attributes
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited