WebhookApi class

Constructors

WebhookApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

deleteWebhookById(String id) → Future<void>
Removes one of the caller org's webhook endpoints and answers 204 with no body.
deleteWebhookByIdWithHttpInfo(String id) → Future<Response>
Removes one of the caller org's webhook endpoints and answers 204 with no body.
getWebhook() → Future<EndpointList?>
Returns every webhook endpoint the caller's org has registered, newest first, each with its 7-day delivery and failure counts.
getWebhookById(String id) → Future<Endpoint?>
Returns one of the caller org's webhook endpoints with its 7-day delivery and failure counts, signing secret redacted.
getWebhookByIdDeliveries(String id, {int? limit, String? status}) → Future<DeliveryList?>
Returns one endpoint's per-attempt delivery log, newest first — the record of what was sent, what the subscriber answered, and how long it took.
getWebhookByIdDeliveriesWithHttpInfo(String id, {int? limit, String? status}) → Future<Response>
Returns one endpoint's per-attempt delivery log, newest first — the record of what was sent, what the subscriber answered, and how long it took.
getWebhookByIdWithHttpInfo(String id) → Future<Response>
Returns one of the caller org's webhook endpoints with its 7-day delivery and failure counts, signing secret redacted.
getWebhookWithHttpInfo() → Future<Response>
Returns every webhook endpoint the caller's org has registered, newest first, each with its 7-day delivery and failure counts.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
postWebhook(CreateEndpointIn createEndpointIn) → Future<Endpoint?>
Registers a new webhook subscription for the caller's org and answers 201 with the endpoint INCLUDING its freshly minted signing secret.
postWebhookByIdSecret(String id) → Future<Endpoint?>
Mints a NEW HMAC signing secret for the endpoint and answers the endpoint WITH it — the only other response besides create that ever carries a secret.
postWebhookByIdSecretWithHttpInfo(String id) → Future<Response>
Mints a NEW HMAC signing secret for the endpoint and answers the endpoint WITH it — the only other response besides create that ever carries a secret.
postWebhookByIdTest(String id) → Future<TestResult?>
Sends ONE signed test event to the endpoint right now and answers the outcome inline, so the console can show whether the subscriber is reachable without waiting for real traffic.
postWebhookByIdTestWithHttpInfo(String id) → Future<Response>
Sends ONE signed test event to the endpoint right now and answers the outcome inline, so the console can show whether the subscriber is reachable without waiting for real traffic.
postWebhookWithHttpInfo(CreateEndpointIn createEndpointIn) → Future<Response>
Registers a new webhook subscription for the caller's org and answers 201 with the endpoint INCLUDING its freshly minted signing secret.
putWebhookById(String id, UpdateEndpointIn updateEndpointIn) → Future<Endpoint?>
Replaces the editable fields of one of the caller org's endpoints — url, events, status and description — and answers the stored row with its secret redacted.
putWebhookByIdWithHttpInfo(String id, UpdateEndpointIn updateEndpointIn) → Future<Response>
Replaces the editable fields of one of the caller org's endpoints — url, events, status and description — and answers the stored row with its secret redacted.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited