Ruby

client.webhooks

Каждый метод этого пространства имён: его сигнатура, параметры, что он возвращает, и пример.

Методы

Endpoints that receive signed mailbox events, their secrets and their delivery log.

`webhooks.list`

List the webhook endpoints in the workspace

webhooks:readПостранично перебирает результаты

Сигнатура

list(limit: nil, cursor: nil, api_key: nil) -> OpenEmail::Page

Returns one page of the webhook endpoints registered on the key's workspace, newest first. list_all collects every page and iterate walks them lazily.

Signing secrets are never part of a read. Only create and rotate_secret return secret, so a lost secret cannot be recovered from here. An endpoint subscribed to every event, which is what an endpoint created without eventTypes is, reports eventTypes as ["*"] rather than an empty Array.

Read enabled, disabledReason and consecutiveFailures as the health summary. An endpoint the server switched off after 100 consecutive failed deliveries shows enabled: false with disabledAt and a reason, while one you disabled yourself through update has both of those nil.

Параметры

limitInteger: Page size, from 1 to 100. The server defaults to 25.
cursorString: The next_cursor of the previous page. Leave it out for the first page.
api_keyString: Overrides the client API key for this call only.

Возвращает

An OpenEmail::Page of endpoint Hashes, with items, has_more? and next_cursor. Each item has id, url, description, eventTypes, enabled, disabledAt, disabledReason, consecutiveFailures, addressAllowlist, domainAllowlist, lastDeliveryAt and createdAt.

Пример

hooks = client.webhooks.list_all unhealthy = hooks.select { |hook| !hook[:enabled] || hook[:consecutiveFailures].positive? } p unhealthy.map { |hook| [hook[:url], hook[:disabledReason]] }

Примечания

A narrowed key reads every endpoint, and may write one whose own addressAllowlist and domainAllowlist sit inside what the key holds. A write that would take an endpoint wider than the key is 422 capability_unsupported on addressAllowlist.
lastDeliveryAt moves on failed attempts as well as successful ones, so it shows the endpoint is being called, not that it is healthy.
The cursor is opaque and holds where the last row sat in this order, so a row deleted or edited between pages never breaks the walk: the next page starts at the first row that sorts after it. A cursor this list did not hand out is a 400 invalid_cursor.

Также доступно в

API: GET /webhooks
TypeScript: webhooks.list()
Python: webhooks.list()
CLI: openemail webhooks list

`webhooks.list_all`

Collect every webhook endpoint into one array

webhooks:readПостранично перебирает результаты

Сигнатура

list_all(limit: nil, cursor: nil, api_key: nil) -> Array<Hash>

Walks every page of list and returns all webhook endpoints, newest first. One request per page.

Параметры

limitInteger: Page size for each request, from 1 to 100. The server defaults to 25.
cursorString: Starts the walk after this cursor instead of the first page.
api_keyString: Overrides the client API key for every page of this walk.

Возвращает

An Array of endpoint Hashes holding every webhook endpoint.

Пример

all = client.webhooks.list_all(limit: 100) puts all.length

Примечания

If any page fails the call raises, and the webhook endpoints already fetched are discarded.

Также доступно в

API: GET /webhooks
TypeScript: webhooks.listAll()
Python: webhooks.list_all()

`webhooks.iterate`

Stream the webhook endpoints one at a time

webhooks:readПостранично перебирает результаты

Сигнатура

iterate(limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>

Returns an Enumerator that yields webhook endpoints individually, newest first, or yields each one to a block when given one, and requests the next page only once the current one is drained. Without a block nothing is fetched until you consume it, and breaking out of the loop stops the requests.

Параметры

limitInteger: Page size for each request, from 1 to 100. The server defaults to 25.
cursorString: Starts the walk after this cursor instead of the first page.
api_keyString: Overrides the client API key for every page of this walk.

Возвращает

An Enumerator of endpoint Hashes (or yields each one to a block), one webhook endpoint per step.

Пример

client.webhooks.iterate { |item| p item }

Примечания

The Enumerator is lazy, so an abandoned loop costs only the pages you consumed.

Также доступно в

API: GET /webhooks
TypeScript: webhooks.iterate()
Python: webhooks.iterate()

`webhooks.get`

Read one webhook endpoint by id

webhooks:read

Сигнатура

get(id, api_key: nil) -> Hash

Returns a single endpoint with its URL, subscription list, enabled state and delivery health. The signing secret is never part of a read. It appears only in the responses of create and rotate_secret, and a lost one is replaced with rotate_secret rather than read back.

An id from another workspace answers exactly like one that never existed, with 404 resource_not_found, so a 404 does not tell you whether the endpoint was deleted or was never yours.

consecutiveFailures resets to 0 on any successful delivery and when update sets enabled to true. When it reaches 100 the server disables the endpoint, fills in disabledAt and disabledReason, and emails the workspace owner and every member whose role can read webhooks.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
api_keyString: Overrides the client API key for this call only.

Возвращает

A Hash with id, url, description, eventTypes, enabled, disabledAt, disabledReason, consecutiveFailures, addressAllowlist, domainAllowlist, lastDeliveryAt and createdAt. No secret.

Пример

hook = client.webhooks.get("whe_3f9c2a7b1e4d8f60a5c7b92d") puts hook[:disabledAt], hook[:disabledReason] if !hook[:enabled] && hook[:disabledReason]

Примечания

eventTypes of ["*"] means the endpoint named none, so it receives the default email.* set. email.replied, domain.*, suppression.*, file.* and form.* sit outside that set and have to be named explicitly.
A GET is retried automatically on network failure and on 408, 429 and 5xx responses, up to the client's max_retries.

Также доступно в

API: GET /webhooks/{id}
TypeScript: webhooks.get()
Python: webhooks.get()
CLI: openemail webhooks get

`webhooks.create`

webhooks:write

Сигнатура

create(body = nil, api_key: nil, **fields) -> Hash

Registers a receiver URL and subscribes it to events on the key's workspace. The endpoint starts enabled, so the next matching event is delivered to it straight away. Leave eventTypes out, or pass an empty Array, and the endpoint receives the default set, which is the email.* events other than email.replied. Every family outside it has to be named: email.replied, domain.*, suppression.*, file.* and form.*. Reads report an unnamed subscription as ["*"].

By default an endpoint hears about every address the workspace owns. addressAllowlist and domainAllowlist narrow it, exactly as the same two lists narrow an API key: name whole domains, single addresses, or both. An event reaches the endpoint when the address or domain it concerns is covered. Events that name no address at all, such as suppression.removed, reach every endpoint whatever its lists say. form.* is the exception: a sign-up belongs to the whole workspace, so an endpoint limited to some addresses or domains never receives form.submitted or form.confirmed.

This response is the only place the full secret ever appears. Every later read omits it, so store it before doing anything else, and if it is lost call rotate_secret. The secret is whsec_ followed by 43 base64url characters, and the HMAC key is the whole string including the prefix, so pass it to OpenEmail.verify_webhook_signature exactly as returned.

url must be https. localhost, hosts ending .localhost, .internal or .local, and IP literals in loopback, private, link local, carrier grade NAT, multicast or unique local ranges are refused with 422 invalid_webhook_url. The host is resolved again on every delivery, and an attempt to a name that resolves into one of those ranges is recorded as failed without being sent. Deliveries never follow redirects, so register the final address.

Параметры

urlStringОбязательно: The https receiver URL. Another scheme or a blocked host is 422 invalid_webhook_url. Stored in normalised form, so the url read back can differ cosmetically.
eventTypesArray<String>: Events to subscribe to. Omit it, or send [], for the default email.* set: email.received, email.sent, email.failed, email.cancelled, email.scheduled, email.queued, email.delivered, email.delivery_delayed, email.bounced, email.complained, email.suppressed, email.opened, email.clicked and email.downloaded. email.replied, domain.verified, domain.sending_changed, domain.deleted, suppression.added, suppression.removed, file.uploaded, file.deleted, form.submitted and form.confirmed are outside that set and have to be named.
descriptionString: Free text note, at most 200 characters.
addressAllowlistArray<String>: Single addresses this endpoint hears about. An event is delivered when the address it concerns is on this list, or when its domain is in domainAllowlist. Leave both empty and the endpoint hears about every address the workspace owns. At most 50, and an address this workspace does not own is 422 invalid_parameter.
domainAllowlistArray<String>: Whole domains this endpoint hears about, including addresses added to them later. A domain also carries its own domain.* events. At most 25. An address whose domain is already listed here is dropped from addressAllowlist when the endpoint is saved, so the two lists never overlap.
api_keyString: Overrides the client API key for this call only.

Возвращает

A Hash with the plaintext secret alongside the fields get returns, id, url, description, eventTypes, enabled, disabledAt, disabledReason, consecutiveFailures, addressAllowlist, domainAllowlist, lastDeliveryAt and createdAt.

Пример

hook = client.webhooks.create(  url: "https://hooks.acme.com/openemail",  eventTypes: ["email.received", "email.bounced", "email.complained"],  description: "Support desk sync") puts hook[:secret]p hook[:id], hook[:eventTypes]

Примечания

Verify each delivery with OpenEmail.verify_webhook_signature(payload:, headers:, secret:), passing the raw request body as a String. It checks the X-OpenEmail-Signature HMAC-SHA256 over the timestamp, a dot and the raw body in constant time, rejects a timestamp more than 300 seconds off, raises OpenEmail::WebhookSignatureError on failure and returns a Hash with id, type, createdAt and data.
Each attempt is one POST with a 5 second timeout. A failure worth repeating (no answer, 408, 425, 429 or a 5xx) is tried again after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, 10 hours and 10 hours, up to 8 attempts over about 27 and a half hours, each wait varied by up to 10% and stretched when your server's Retry-After asks for longer, up to 6 hours. A 410 Gone switches the endpoint off. list_deliveries shows every attempt with its number, and replay_delivery sends one of them again, one event at a time, once your receiver is fixed.
A workspace holds 10 endpoints by default, and support can raise that for a workspace that needs more. The next one past the limit is 422 workspace_limit_reached. A narrowed key may create an endpoint, but only one whose own lists sit inside what the key holds; anything wider is 422 capability_unsupported on addressAllowlist.
Not retried automatically, so a network failure can leave an endpoint created with a secret you never saw. Check list before creating it again.

Также доступно в

API: POST /webhooks
TypeScript: webhooks.create()
Python: webhooks.create()
CLI: openemail webhooks create

`webhooks.update`

Change an endpoint URL, events or enabled state

webhooks:write

Сигнатура

update(id, patch = nil, api_key: nil, **fields) -> Hash

Patches the URL, subscription list, description or enabled flag of one endpoint. Every field is optional, and an empty patch is accepted and changes nothing you can read back. A new url goes through the same https and host checks as create, and description: nil clears the note.

eventTypes replaces the subscription set wholesale, so send the complete list you want rather than a delta. An empty Array does not unsubscribe: it puts the endpoint back on the default email.* set. To stop deliveries, set enabled to false instead.

addressAllowlist and domainAllowlist replace the endpoint's scope the same way, wholesale rather than as a delta. Send both empty to widen it back to every address the workspace owns. Each list is checked against the domains and addresses this workspace actually owns, and an unknown one is 422 invalid_parameter.

Writing enabled clears disabledAt and disabledReason either way, so an endpoint you switch off yourself reports both as nil. Setting it back to true also resets consecutiveFailures to 0, which is how an endpoint the server disabled after 100 failures is brought back. Events that fire while an endpoint is disabled are never delivered to it later, but a delivery that failed before it was switched off can be sent again with replay_delivery once it is back on, one event at a time.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
urlString: Replacement https URL, checked against the same host rules as create.
eventTypesArray<String>: Complete replacement subscription set. [] means the default email.* set.
addressAllowlistArray<String>: Complete replacement list of single addresses this endpoint hears about. At most 50. Send [] on both lists to hear about every address again.
domainAllowlistArray<String>: Complete replacement list of whole domains this endpoint hears about, including addresses added to them later. At most 25.
descriptionString: Replacement note of at most 200 characters, or nil to clear it.
enabledBoolean: False stops deliveries. True resumes them and resets consecutiveFailures.
api_keyString: Overrides the client API key for this call only.

Возвращает

The endpoint Hash as saved, shaped like the one get returns. The signing secret is untouched and not included.

Пример

updated = client.webhooks.update(  "whe_3f9c2a7b1e4d8f60a5c7b92d",  eventTypes: ["email.sent", "email.bounced", "email.complained"],  enabled: true) p updated[:eventTypes], updated[:consecutiveFailures]

Примечания

Read the current eventTypes first if you mean to add one, since a partial list silently unsubscribes the rest. The same applies to the two allowlists. Do not send back ["*"] as read: it is a 422 invalid_parameter, and [] is how to ask for the default set.
This route never touches the signing secret. Use rotate_secret for that.
Retried automatically on network failure and retryable statuses, since the same patch applied twice lands on the same row.

Также доступно в

API: PATCH /webhooks/{id}
TypeScript: webhooks.update()
Python: webhooks.update()
CLI: openemail webhooks update

`webhooks.delete`

Delete an endpoint and its delivery log

webhooks:write

Сигнатура

delete(id, api_key: nil) -> Hash

Removes the endpoint for good. Deliveries stop immediately, the signing secret is gone, and the delivery log for the endpoint is deleted with it, so read it with list_all_deliveries first if you need it for an audit trail.

There is no undo and no soft delete. If the aim is only to pause deliveries, call update with enabled: false and keep the endpoint, its secret and its log.

The response is a tombstone rather than an empty body, so a log line can name what went. Deleting frees a slot against the workspace's endpoint limit straight away.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
api_keyString: Overrides the client API key for this call only.

Возвращает

A Hash with object set to webhook, the id and deleted set to true.

Пример

log = client.webhooks.list_all_deliveries("whe_3f9c2a7b1e4d8f60a5c7b92d") removed = client.webhooks.delete("whe_3f9c2a7b1e4d8f60a5c7b92d") puts log.length, removed[:deleted]

Примечания

Not idempotent: a second call on the same id is 404 resource_not_found, and the SDK does not retry it after a network failure.
A narrowed key may delete only an endpoint whose own allowlists sit inside what the key holds; any other is 422 capability_unsupported on addressAllowlist.

Также доступно в

API: DELETE /webhooks/{id}
TypeScript: webhooks.delete()
Python: webhooks.delete()
CLI: openemail webhooks delete

`webhooks.rotate_secret`

Issue a new signing secret for an endpoint

webhooks:write

Сигнатура

rotate_secret(id, api_key: nil) -> Hash

Generates a new signing secret and returns the endpoint plus the new plaintext secret. As with create, this response is the only place that secret appears, so store it before anything else.

There is no overlap window. Every delivery is signed at send time with the current secret, so the old one stops verifying the moment this call commits, and any event that fires before your receiver has the new secret fails verification on your side.

The safe order is to deploy a receiver that tries both the old secret and a new one read from config, call this, write the returned secret to config, then drop the old one. test confirms the new secret verifies before you remove the fallback.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
api_keyString: Overrides the client API key for this call only.

Возвращает

The endpoint Hash, shaped like the one get returns, plus the new secret, formatted whsec_ followed by 43 base64url characters.

Пример

rotated = client.webhooks.rotate_secret("whe_3f9c2a7b1e4d8f60a5c7b92d") puts rotated[:secret] check = client.webhooks.test(rotated[:id]) puts check.dig(:delivery, :status)

Примечания

There is no request body and the success status is 200, not 201.
Not retried automatically. A lost response means a secret you never saw is already live, so rotate again rather than waiting.
Subscriptions, enabled state and consecutiveFailures are left as they were.

Также доступно в

API: POST /webhooks/{id}/rotate-secret
TypeScript: webhooks.rotateSecret()
Python: webhooks.rotate_secret()
CLI: openemail webhooks rotate-secret

`webhooks.test`

Send a synthetic event and report how delivery went

webhooks:write

Сигнатура

test(id, api_key: nil) -> Hash

Posts a signed synthetic email.sent event to the endpoint and waits for the attempt to finish before returning. The payload data holds test set to true and a note, and no mail is sent, so it is safe against a production receiver. It proves the URL is reachable and that your signature check accepts the current secret before real mail depends on it.

The outcome comes back as delivery, read from the newest row of the delivery log. status is delivered for any 2xx answer and failed otherwise, responseCode is the HTTP status or nil when no response arrived, such as a DNS failure or the 5 second timeout, and error explains a failure. A 3xx counts as failed because redirects are never followed.

The event goes out whatever the endpoint subscribes to, and even when it is disabled. It is recorded like any delivery, so it appears in list_deliveries and can be sent again with replay_delivery, but it is tried once and leaves consecutiveFailures and lastDeliveryAt alone, so a failing test never counts toward the 100 that disable an endpoint. A 410 Gone answer does switch the endpoint off, as it would for a real event.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
api_keyString: Overrides the client API key for this call only.

Возвращает

A Hash with object set to webhook_test, the endpoint id, and delivery, a Hash with status, responseCode, durationMs and error, or nil when no delivery row could be read back.

Пример

result = client.webhooks.test("whe_3f9c2a7b1e4d8f60a5c7b92d") unless result.dig(:delivery, :status) == "delivered"  p result.dig(:delivery, :responseCode), result.dig(:delivery, :error)end

Примечания

The call returns normally, with a 200, when your receiver fails. Branch on delivery[:status], not on whether the call raised.
A 4xx from your receiver is a useful answer: the URL is reachable and the rejection came from your own handler, often its signature check.
Not retried automatically, since every call sends another request to your receiver.
If a real event reaches the same endpoint at the same moment, delivery can describe that attempt instead, because it reads the newest log row.

Также доступно в

API: POST /webhooks/{id}/test
TypeScript: webhooks.test()
Python: webhooks.test()
CLI: openemail webhooks test

`webhooks.list_deliveries`

List one page of delivery attempts for one endpoint

webhooks:readПостранично перебирает результаты

Сигнатура

list_deliveries(id, status: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> OpenEmail::Page

Returns one page of an endpoint's delivery log, newest first. Nothing is dropped from the log, so following next_cursor while has_more? is true reaches the endpoint's very first delivery, and list_all_deliveries and iterate_deliveries do that walk for you. status:, since: and until: narrow it the way the Deliveries tab of the app does: status: "failed" is its "only failed" switch.

Each attempt is one POST with a 5 second timeout, and one event can appear several times: when the failure is worth repeating, a delivery is tried up to 8 times, as it happens and then after 1 minute, 5 minutes, 30 minutes, 2 hours, 5 hours, 10 hours and 10 hours, about 27 and a half hours in all, and each replay_delivery adds a row of its own. attempt and maxAttempts say which try a row is, and eventId is the same across all of them, so this log distinguishes a retry from a new event. nextAttemptAt is when the automatic retry that follows a row is due, and nil when none is waiting, so a failed row with a time in it is not the final word. status is delivered for a 2xx answer and failed for anything else, including a 3xx, since redirects are not followed.

responseCode nil means no response arrived, such as a DNS or TLS failure or the timeout, which is a different fact from a receiver that answered. durationMs is nil only when the attempt was never made because the server could not read the signing secret, and error then says so. The body that was sent and your server's answer are not part of this response, and get_delivery returns both. list_workspace_deliveries reads every endpoint at once.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
statusString: failed keeps only the attempts that did not get a 2xx, the "only failed" view of the app; delivered keeps the rest.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Rows per page, a whole number from 1 to 100. The server defaults to 25.
cursorString: The next_cursor from the previous page, passed back unchanged. Never build one yourself.
api_keyString: Overrides the client API key for this call only.

Возвращает

An OpenEmail::Page of delivery Hashes, with items, has_more? and next_cursor. Each item has id, endpointId, eventType, eventId, status, responseCode, durationMs, attempt, maxAttempts, error, createdAt and nextAttemptAt.

Пример

page = client.webhooks.list_deliveries(  "whe_3f9c2a7b1e4d8f60a5c7b92d",  status: "failed",  since: Time.now - 24 * 60 * 60,  limit: 50) p page.items.map { |delivery| [delivery[:eventType], delivery[:responseCode], delivery[:error]] }p page.has_more?, page.next_cursor

Примечания

Synthetic events from test appear here too, recorded as email.sent.
Each endpoint's copy of an event gets its own evt_ id, sent in the X-OpenEmail-Delivery header and as the payload id, and every retry and replay of that copy keeps it. One event fanned out to two endpoints arrives with two different ids, and a repeat to one endpoint arrives with the same one.
The cursor stays valid under every filter as long as each page sends the same status:, since: and until:, which list_all_deliveries and iterate_deliveries do for you.
A 404 resource_not_found means the endpoint id is wrong or belongs to another workspace, not that the log is empty. A cursor that names no delivery of this endpoint is a 400 invalid_cursor, and a since or until that does not parse is a 400 invalid_parameter.

Также доступно в

API: GET /webhooks/{id}/deliveries
TypeScript: webhooks.listDeliveries()
Python: webhooks.list_deliveries()
CLI: openemail webhooks list-deliveries

`webhooks.list_all_deliveries`

Collect an endpoint's whole delivery log into one array

webhooks:readПостранично перебирает результаты

Сигнатура

list_all_deliveries(id, status: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>

Walks every page of an endpoint's delivery log and returns all of its attempts, newest first, under the same status:, since: and until: filters as list_deliveries. The log is never pruned, so an endpoint that has been busy for a long time can hold a great many rows; narrow it with a window, or prefer iterate_deliveries when you can stop early.

Pages are keyset on createdAt and id, walking backwards in time. Attempts recorded after the walk starts are newer than its first page and are not included.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
statusString: failed keeps only the attempts that did not get a 2xx, the "only failed" view of the app; delivered keeps the rest.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Page size for each request, 1 to 100. The server defaults to 25.
cursorString: Starts the walk from this cursor instead of the newest row.
api_keyString: Overrides the client API key for every page of this walk.

Возвращает

An Array of delivery Hashes holding every matching attempt on the endpoint, newest first.

Пример

failures = client.webhooks.list_all_deliveries("whe_3f9c2a7b1e4d8f60a5c7b92d", status: "failed", limit: 100) failed_events = failures.map { |delivery| delivery[:eventId] }.uniq puts "#{failed_events.size} events had a failed attempt"

Примечания

If any page fails the call raises, and the attempts already fetched are discarded.
One request per page, so a large log takes many requests. Read it with iterate_deliveries to stop as soon as you have what you need.

Также доступно в

API: GET /webhooks/{id}/deliveries
TypeScript: webhooks.listAllDeliveries()
Python: webhooks.list_all_deliveries()

`webhooks.iterate_deliveries`

Stream an endpoint's delivery attempts one at a time, newest first

webhooks:readПостранично перебирает результаты

Сигнатура

iterate_deliveries(id, status: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>

Returns an Enumerator over an endpoint's delivery log that yields attempts individually, or yields each one to a block when given one, and fetches the next page only when the current one is drained, under the same status:, since: and until: filters as list_deliveries. Without a block nothing is requested until you consume it, and breaking out of the loop stops further requests, which makes it the right way to find the latest attempt of some kind without reading the whole history.

The walk ends when has_more? is false, when a page carries no next_cursor, or when the server repeats a cursor. Attempts recorded after the walk starts are newer than its cursor and are not yielded.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
statusString: failed keeps only the attempts that did not get a 2xx, the "only failed" view of the app; delivered keeps the rest.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Page size per request, 1 to 100. The server defaults to 25.
cursorString: Starts the walk from this cursor instead of the newest row.
api_keyString: Overrides the client API key for every page of this walk.

Возвращает

An Enumerator of delivery Hashes (or yields each one to a block), one attempt per step.

Пример

client.webhooks.iterate_deliveries("whe_3f9c2a7b1e4d8f60a5c7b92d", status: "failed") do |delivery|  next unless delivery[:nextAttemptAt].nil?   puts "#{delivery[:createdAt]} #{delivery[:eventType]} #{delivery[:responseCode]} #{delivery[:error]}"  breakend

Примечания

A page request that fails raises out of the loop, after every attempt of the pages before it has been yielded.

Также доступно в

API: GET /webhooks/{id}/deliveries
TypeScript: webhooks.iterateDeliveries()
Python: webhooks.iterate_deliveries()

`webhooks.get_delivery`

Read one delivery attempt in full, with the body that was sent

webhooks:read

Сигнатура

get_delivery(id, delivery_id, api_key: nil) -> Hash

Returns one attempt from an endpoint's delivery log with what list_deliveries leaves out. payload is the exact JSON body that was POSTed, a Hash with id, type, createdAt and data, and responseBody is the first 2,000 characters your server answered, or nil when nothing came back or the answer was a redirect.

attempts lists every try of the same event on this endpoint, oldest first: the first attempt, the automatic retries and any replays, each with its own id, attempt, status, responseCode, error and createdAt. They share eventId, which is the payload id your receiver saw. nextAttemptAt is when the next automatic retry of the event is due, whichever attempt it follows, and nil when none is waiting.

replayRefusal says whether replay_delivery would accept this attempt before you call it: nil when it would, and otherwise the code and message the replay would be refused with, such as webhook_disabled while the endpoint is switched off, or retry_in_progress while an automatic retry of the same event is being sent.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
delivery_idStringОбязательно: Delivery id, whd_ followed by 24 hex characters, as list_deliveries returns it.
api_keyString: Overrides the client API key for this call only.

Возвращает

A Hash with the fields of a list_deliveries row (id, eventType, eventId, status, responseCode, durationMs, attempt, maxAttempts, error, createdAt, nextAttemptAt) plus endpointId, payload, responseBody, attempts and replayRefusal.

Пример

detail = client.webhooks.get_delivery("whe_3f9c2a7b1e4d8f60a5c7b92d", "whd_8c1e4a7f2b9d3e6a0c5f1b28") p detail.dig(:payload, :type), detail[:responseCode], detail[:responseBody]p detail[:attempts].map { |attempt| [attempt[:attempt], attempt[:status], attempt[:responseCode]] } refusal = detail[:replayRefusal]puts refusal[:code], refusal[:message] if refusal

Примечания

A delivery id that belongs to another endpoint, even one in the same workspace, is 404 resource_not_found, exactly like one that never existed.
Your server's answer is cut at 2,000 characters when it is recorded, so a longer one reads back truncated.
A GET is retried automatically on network failure and on 408, 429 and 5xx responses, up to the client's max_retries.
A narrowed key may read a delivery only on an endpoint whose own allowlists sit inside what the key holds, where holding one address never covers its whole domain, because the body names the addresses the event is about; any other is 422 capability_unsupported on addressAllowlist. Over OAuth only the workspace owner, or a member whose role holds addresses:all, may read one, and any other member's token is 403 owner_only. That member's token is held to the domains the workspace has now, so it reads only a delivery of an endpoint with allowlists, and one with none is 422 capability_unsupported for it too.

Также доступно в

API: GET /webhooks/{id}/deliveries/{deliveryId}
TypeScript: webhooks.getDelivery()
Python: webhooks.get_delivery()
CLI: openemail webhooks get-delivery

`webhooks.replay_delivery`

Send one stored event to the endpoint again, now

webhooks:write

Сигнатура

replay_delivery(id, delivery_id, api_key: nil) -> Hash

Posts the event behind a recorded attempt to the endpoint once more, straight away, and returns when that attempt has finished. The body is the one stored with the original, with the same id, type, createdAt and data, so a receiver that drops ids it has already handled treats the replay as the event it already knows. Only X-OpenEmail-Signature is new, because every POST is signed with the current secret at the moment it goes out, so a replay verifies after a rotate_secret too.

It accepts a delivered attempt as well as a failed one. Replaying a success is how a receiver that lost its copy, or handled it wrongly, is brought back in step. Any attempt of the event will do, since they all carry the same event.

The replay is recorded in the log as a new delivery, attempt 1 of 1, and is never retried automatically. Before it goes out, the automatic retries of the same event that have not started are paused, so the receiver never gets two copies at once. When the replay is delivered they stay cancelled; when it fails they resume on their schedule. If an automatic retry of the event is being sent at that very moment, the replay sends nothing and is refused with 409 retry_in_progress, and if another replay of the same event is still being sent, it is refused with 409 replay_in_progress, so two copies never go out at once. The call returns normally, with a 200, whatever your server answered, so branch on delivery[:status] rather than on whether the call raised.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
delivery_idStringОбязательно: Any attempt of the event to send again, whd_ followed by 24 hex characters.
api_keyString: Overrides the client API key for this call only.

Возвращает

A Hash with object set to webhook_replay, id (the new delivery), endpointId, replayOf (the attempt you named), eventId, eventType, and delivery, a Hash with status, responseCode, durationMs and error.

Пример

replay = client.webhooks.replay_delivery("whe_3f9c2a7b1e4d8f60a5c7b92d", "whd_8c1e4a7f2b9d3e6a0c5f1b28")delivery = replay[:delivery] p delivery[:responseCode], delivery[:error] unless delivery[:status] == "delivered"

Примечания

Refused with 409 when nobody who wants the event would receive it: webhook_disabled while the endpoint is switched off, event_not_subscribed when it no longer listens for the event type, event_out_of_scope when its allowlists no longer cover the address the event is about, delivery_not_replayable when the attempt has no stored event, retry_in_progress while an automatic retry of the same event is being sent, and replay_in_progress while another replay of it is. Wait a few seconds and check get_delivery before replaying again, since that retry or replay may deliver it. get_delivery reports the same answer in advance as replayRefusal. A synthetic event from test replays whatever the endpoint subscribes to.
Not retried automatically, because a retry after a lost response would send the event again. A receiver that drops repeated ids handles that safely, but the SDK does not assume yours does.
A delivered replay resets consecutiveFailures, and a failed one does not add to it. A 410 Gone switches the endpoint off, as it does for an automatic delivery.
A narrowed key may replay only on an endpoint whose own allowlists sit inside what the key holds; any other is 422 capability_unsupported on addressAllowlist.

Также доступно в

API: POST /webhooks/{id}/deliveries/{deliveryId}/replay
TypeScript: webhooks.replayDelivery()
Python: webhooks.replay_delivery()
CLI: openemail webhooks replay-delivery

`webhooks.list_workspace_deliveries`

List one page of delivery attempts across every endpoint

webhooks:readПостранично перебирает результаты

Сигнатура

list_workspace_deliveries(endpoint_ids: nil, status: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> OpenEmail::Page

Returns one page of the whole workspace's delivery log, newest first: the all-endpoints Deliveries tab of the app. Each row carries endpointId, so the endpoint an attempt went to is never lost. endpoint_ids: narrows it to some endpoints, and status:, since: and until: work exactly as they do on list_deliveries.

Nothing is pruned, so following next_cursor while has_more? is true reaches the workspace's first delivery; list_all_workspace_deliveries and iterate_workspace_deliveries do that walk. The body that was sent is not here: read it with get_delivery, passing the row's endpointId and id.

Параметры

endpoint_idsArray<String>: Endpoint ids to read, at most 50, sent comma-separated. Left out, every endpoint in the workspace.
statusString: failed keeps only the attempts that did not get a 2xx, the "only failed" view of the app; delivered keeps the rest.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Rows per page, a whole number from 1 to 100. The server defaults to 25.
cursorString: The next_cursor from the previous page, passed back unchanged. Never build one yourself.
api_keyString: Overrides the client API key for this call only.

Возвращает

Пример

page = client.webhooks.list_workspace_deliveries(status: "failed", limit: 50) page.items.each do |delivery|  puts "#{delivery[:endpointId]} #{delivery[:eventType]} #{delivery[:responseCode]}"end

Примечания

An endpoint id in endpoint_ids: that belongs to no endpoint here simply matches nothing. A removed endpoint takes its deliveries with it.
The cursor stays valid under every filter as long as each page sends the same endpoint_ids:, status:, since: and until:, which list_all_workspace_deliveries and iterate_workspace_deliveries do for you.
The list carries no payloads, so a key narrowed to some addresses may read it; opening a delivery with get_delivery is where the narrowing applies.

Также доступно в

API: GET /webhooks/deliveries
TypeScript: webhooks.listWorkspaceDeliveries()
Python: webhooks.list_workspace_deliveries()
CLI: openemail webhooks list-workspace-deliveries

`webhooks.list_all_workspace_deliveries`

Collect the workspace's whole delivery log into one array

webhooks:readПостранично перебирает результаты

Сигнатура

list_all_workspace_deliveries(endpoint_ids: nil, status: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>

Walks every page of list_workspace_deliveries under the same filters and returns every matching attempt, newest first. The log is never pruned, so give it a since: or endpoint_ids: unless you mean to read all of it, or use iterate_workspace_deliveries to stop early.

Параметры

endpoint_idsArray<String>: Endpoint ids to read, at most 50, sent comma-separated. Left out, every endpoint in the workspace.
statusString: failed keeps only the attempts that did not get a 2xx, the "only failed" view of the app; delivered keeps the rest.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Page size for each request, 1 to 100. The server defaults to 25.
cursorString: Starts the walk from this cursor instead of the newest row.
api_keyString: Overrides the client API key for every page of this walk.

Возвращает

An Array of delivery Hashes holding every matching attempt, newest first.

Пример

last_day = client.webhooks.list_all_workspace_deliveries(  status: "failed",  since: Time.now - 24 * 60 * 60,  limit: 100) puts "#{last_day.length} failed attempts in the last day"

Примечания

If any page fails the call raises, and the attempts already fetched are discarded.

Также доступно в

API: GET /webhooks/deliveries
TypeScript: webhooks.listAllWorkspaceDeliveries()
Python: webhooks.list_all_workspace_deliveries()

`webhooks.iterate_workspace_deliveries`

Stream the workspace's delivery attempts one at a time, newest first

webhooks:readПостранично перебирает результаты

Сигнатура

iterate_workspace_deliveries(endpoint_ids: nil, status: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>

An Enumerator over list_workspace_deliveries under the same filters, or a walk that yields each attempt to a block when given one. It fetches a page only when the one before is drained and stops requesting when you break out of the loop.

Параметры

endpoint_idsArray<String>: Endpoint ids to read, at most 50, sent comma-separated. Left out, every endpoint in the workspace.
statusString: failed keeps only the attempts that did not get a 2xx, the "only failed" view of the app; delivered keeps the rest.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Page size per request, 1 to 100. The server defaults to 25.
cursorString: Starts the walk from this cursor instead of the newest row.
api_keyString: Overrides the client API key for every page of this walk.

Возвращает

An Enumerator of delivery Hashes (or yields each one to a block), one attempt per step.

Пример

client.webhooks.iterate_workspace_deliveries(status: "failed") do |delivery|  detail = client.webhooks.get_delivery(delivery.fetch(:endpointId), delivery.fetch(:id))  puts "replayable #{delivery[:id]}" if detail[:replayRefusal].nil?end

Примечания

A page request that fails raises out of the loop, after every attempt of the pages before it has been yielded.

Также доступно в

API: GET /webhooks/deliveries
TypeScript: webhooks.iterateWorkspaceDeliveries()
Python: webhooks.iterate_workspace_deliveries()

`webhooks.list_activity`

List one page of what happened to one endpoint

webhooks:readПостранично перебирает результаты

Сигнатура

list_activity(id, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> OpenEmail::Page

Returns one page of an endpoint's audit log, newest first, the Activity tab of the endpoint in the app. Every change is a row: created, updated, enabled, disabled, auto_disabled, secret_rotated, tested, replayed and removed, whether it came from the app, from a key over the API, or from OpenEmail itself. actor says who, with label already formatted the way the app shows it: @username for a person, API key <name> for a key, and actor is nil when OpenEmail made the change on its own, such as switching an endpoint off after 100 failed events in a row. detail carries what moved: the URL, previousUrl when it changed, the event types and allowlists an update set, or the status and response code a test or a replay got.

Nothing is pruned, and a removed endpoint keeps its history, so this answers for an endpoint that is gone too. since: and until: keep a window.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Rows per page, a whole number from 1 to 100. The server defaults to 25.
cursorString: The next_cursor from the previous page, passed back unchanged. Never build one yourself.
api_keyString: Overrides the client API key for this call only.

Возвращает

An OpenEmail::Page of change Hashes, with items, has_more? and next_cursor. Each item has id, endpointId, endpointLabel, type, createdAt, actor and detail.

Пример

page = client.webhooks.list_activity("whe_3f9c2a7b1e4d8f60a5c7b92d") page.items.each do |change|  puts "#{change[:createdAt]} #{change[:type]} #{change.dig(:actor, :label) || "OpenEmail"}"end

Примечания

A 404 means no endpoint and no history with that id exists in this workspace. The cursor is opaque: pass next_cursor back as it came, and one this list did not hand out is a 400 invalid_cursor.

Также доступно в

API: GET /webhooks/{id}/activity
TypeScript: webhooks.listActivity()
Python: webhooks.list_activity()
CLI: openemail webhooks list-activity

`webhooks.list_all_activity`

Collect one endpoint's whole audit log into one array

webhooks:readПостранично перебирает результаты

Сигнатура

list_all_activity(id, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>

Walks every page of list_activity under the same window and returns every change, newest first.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Page size for each request, 1 to 100. The server defaults to 25.
cursorString: Starts the walk from this cursor instead of the newest row.
api_keyString: Overrides the client API key for every page of this walk.

Возвращает

An Array of change Hashes, newest first.

Пример

history = client.webhooks.list_all_activity("whe_3f9c2a7b1e4d8f60a5c7b92d") rotations = history.select { |change| change[:type] == "secret_rotated" } p rotations.map { |change| [change[:createdAt], change.dig(:actor, :label)] }

Примечания

If any page fails the call raises, and the rows already fetched are discarded.

Также доступно в

API: GET /webhooks/{id}/activity
TypeScript: webhooks.listAllActivity()
Python: webhooks.list_all_activity()

`webhooks.iterate_activity`

Stream one endpoint's audit log one change at a time

webhooks:readПостранично перебирает результаты

Сигнатура

iterate_activity(id, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>

An Enumerator over list_activity under the same window, or a walk that yields each change to a block when given one, fetching a page only when the one before is drained.

Параметры

idStringОбязательно: Endpoint id, whe_ followed by 24 hex characters.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Page size per request, 1 to 100. The server defaults to 25.
cursorString: Starts the walk from this cursor instead of the newest row.
api_keyString: Overrides the client API key for every page of this walk.

Возвращает

An Enumerator of change Hashes (or yields each one to a block), one change per step.

Пример

client.webhooks.iterate_activity("whe_3f9c2a7b1e4d8f60a5c7b92d") do |change|  next unless change[:type] == "auto_disabled"   puts "switched off by OpenEmail at #{change[:createdAt]} #{change[:detail]}"  breakend

Также доступно в

API: GET /webhooks/{id}/activity
TypeScript: webhooks.iterateActivity()
Python: webhooks.iterate_activity()

`webhooks.list_workspace_activity`

List one page of what happened to every endpoint

webhooks:readПостранично перебирает результаты

Сигнатура

list_workspace_activity(endpoint_ids: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> OpenEmail::Page

Returns one page of the whole workspace's webhook audit log, newest first, the Activity tab of Settings, Webhooks. Every change is a row: created, updated, enabled, disabled, auto_disabled, secret_rotated, tested, replayed and removed, whether it came from the app, from a key over the API, or from OpenEmail itself. actor says who, with label already formatted the way the app shows it: @username for a person, API key <name> for a key, and actor is nil when OpenEmail made the change on its own, such as switching an endpoint off after 100 failed events in a row. detail carries what moved: the URL, previousUrl when it changed, the event types and allowlists an update set, or the status and response code a test or a replay got.

endpoint_ids: narrows it to some endpoints, removed ones included, and since: and until: keep a window.

Параметры

endpoint_idsArray<String>: Endpoint ids to read, at most 50, sent comma-separated. Left out, every endpoint in the workspace.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Rows per page, a whole number from 1 to 100. The server defaults to 25.
cursorString: The next_cursor from the previous page, passed back unchanged. Never build one yourself.
api_keyString: Overrides the client API key for this call only.

Возвращает

An OpenEmail::Page of change Hashes, with items, has_more? and next_cursor. Each item has id, endpointId, endpointLabel, type, createdAt, actor and detail.

Пример

page = client.webhooks.list_workspace_activity(since: "2026-09-01T00:00:00Z") page.items.each do |change|  puts "#{change[:endpointLabel]} #{change[:type]} #{change.dig(:actor, :label) || "OpenEmail"}"end

Примечания

The cursor is opaque: pass next_cursor back as it came. One this list did not hand out is a 400 invalid_cursor.

Также доступно в

API: GET /webhooks/activity
TypeScript: webhooks.listWorkspaceActivity()
Python: webhooks.list_workspace_activity()
CLI: openemail webhooks list-workspace-activity

`webhooks.list_all_workspace_activity`

Collect the whole webhook audit log into one array

webhooks:readПостранично перебирает результаты

Сигнатура

list_all_workspace_activity(endpoint_ids: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>

Walks every page of list_workspace_activity under the same filters and returns every change, newest first.

Параметры

endpoint_idsArray<String>: Endpoint ids to read, at most 50, sent comma-separated. Left out, every endpoint in the workspace.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Page size for each request, 1 to 100. The server defaults to 25.
cursorString: Starts the walk from this cursor instead of the newest row.
api_keyString: Overrides the client API key for every page of this walk.

Возвращает

An Array of change Hashes, newest first.

Пример

changes = client.webhooks.list_all_workspace_activity(since: Time.utc(2026, 9, 1)) by_keys = changes.count { |change| change.dig(:actor, :kind) == "apiKey" } puts "#{by_keys} changes made by keys"

Примечания

If any page fails the call raises, and the rows already fetched are discarded.

Также доступно в

API: GET /webhooks/activity
TypeScript: webhooks.listAllWorkspaceActivity()
Python: webhooks.list_all_workspace_activity()

`webhooks.iterate_workspace_activity`

Stream the whole webhook audit log one change at a time

webhooks:readПостранично перебирает результаты

Сигнатура

iterate_workspace_activity(endpoint_ids: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>

An Enumerator over list_workspace_activity under the same filters, or a walk that yields each change to a block when given one, fetching a page only when the one before is drained.

Параметры

endpoint_idsArray<String>: Endpoint ids to read, at most 50, sent comma-separated. Left out, every endpoint in the workspace.
sinceTime, DateTime, Date or String: Only rows at or after this instant. A Time is sent as a UTC ISO 8601 instant, and a String must already be one.
untilTime, DateTime, Date or String: Only rows before this instant. It has to be later than since, or the server answers 400 invalid_parameter.
limitInteger: Page size per request, 1 to 100. The server defaults to 25.
cursorString: Starts the walk from this cursor instead of the newest row.
api_keyString: Overrides the client API key for every page of this walk.

Возвращает

An Enumerator of change Hashes (or yields each one to a block), one change per step.

Пример

client.webhooks.iterate_workspace_activity do |change|  puts "#{change[:endpointLabel]} was removed by #{change.dig(:actor, :label)}" if change[:type] == "removed"end

Также доступно в

API: GET /webhooks/activity
TypeScript: webhooks.iterateWorkspaceActivity()
Python: webhooks.iterate_workspace_activity()

`webhooks.list_events`

List the events an endpoint can subscribe to

webhooks:read

Сигнатура

list_events(api_key: nil) -> Hash

Returns every event an endpoint can name in eventTypes, each with a sentence saying when it fires, and the limits an endpoint is held to: how many endpoints the workspace may have, which its plan decides, and how many addresses and domains one allowlist may name.

An endpoint that names no events receives every email event except email.replied, so email.replied and the domain, suppression, file and form families only reach an endpoint that asks for them by name.

Параметры

api_keyString: Overrides the client API key for this call only.

Возвращает

A Hash with events, each a Hash with id and label, plus maxEndpoints, maxAddresses and maxDomains.

Пример

catalogue = client.webhooks.list_events catalogue[:events].each { |event| puts "#{event[:id]} #{event[:label]}" }puts "up to #{catalogue[:maxEndpoints]} endpoints"

Примечания

The same event ids are in OpenEmail::WEBHOOK_EVENTS, so a build that only needs the ids can skip the call.
Retried automatically on network failure, since it only reads.

Также доступно в

API: GET /webhooks/events
TypeScript: webhooks.listEvents()
Python: webhooks.list_events()
CLI: openemail webhooks list-events

`webhooks.stats`

Read how webhook deliveries went inside a window

webhooks:read

Сигнатура

stats(endpoint_ids: nil, since: nil, until: nil, grain: nil, offset_minutes: nil, api_key: nil) -> Hash

Returns the numbers behind the Analytics tab of the Webhooks page: how many delivery attempts were made, how many were delivered and how many failed, the median time a receiver took to answer, a series of buckets, the events sent and the response codes received.

It covers every endpoint, or the ones endpoint_ids: names. Each try of an event counts as one attempt, so an event retried three times counts three times. The window runs from since: to until:, and left out it is the 30 days before now. grain: sets the bucket width and the key shape, YYYY-MM-DD, YYYY-MM-DDTHH or YYYY-MM-DDTHH:MM, and offset_minutes: shifts the boundaries so days break where the reader's day does.

Параметры

endpoint_idsArray<String>: Only these endpoints, at most 50. Left out, every endpoint.
sinceTime, DateTime, Date or String: The start of the window, a Time or an ISO 8601 instant. Defaults to 30 days before until.
untilTime, DateTime, Date or String: The end of the window, not included. Defaults to now.
grainString: Bucket width: minute, hour or day, defaulting to day.
offset_minutesInteger: Minutes east of UTC to bucket in, from -840 to 840, defaulting to 0. Pass Time.now.utc_offset / 60 for the local zone.
api_keyString: Overrides the client API key for this call only.

Возвращает

A Hash with the window it covered (since, until, grain and endpointIds), totals (attempts, delivered, failed and medianDurationMs), buckets (each with bucket, delivered and failed), and events and codes (each with id and count).

Пример

stats = client.webhooks.stats(since: Time.now - 7 * 86_400, grain: "day") puts "#{stats[:totals][:failed]} of #{stats[:totals][:attempts]} attempts failed"p stats[:codes]

Примечания

buckets is sparse: a bucket with no attempt has no entry, so a chart must fill the gaps.
medianDurationMs is nil when nothing was sent in the window.
Retried automatically on network failure, since it only reads.

Также доступно в

API: GET /webhooks/stats
TypeScript: webhooks.stats()
Python: webhooks.stats()
CLI: openemail webhooks stats