EmailmoversMyDataHub docs
Browse the docs

Reference / REST reference

Reference

List events

GET /v1/events. Replay events from the last 30 days, oldest first, in the same envelope webhooks deliver.

Generated from the contractsView as Markdown

GET /v1/events

Replay events from the last 30 days, oldest first, in the same envelope webhooks deliver. Use since to catch up after downtime.

PropertyValue
EndpointGET https://mydatahub.emailmovers.com/v1/events
Operation idlistEvents
CostFree (0 credits)
AccessAn API key or an OAuth 2.1 token with the scope webhooks:write.
TagWebhooks

Request

Parameters

NameInTypeRequiredDescription
sincequerystring (date-time)noEvents after this time, up to 30 days back.
typequeryenum: order.ready, order.failed, audience.refreshed, credits.low, credits.topped_up, warranty.replacement_issued, suppression.created, push.completed, push.partial, push.failed, connection.expiredno
limitqueryinteger (1 to 100)noItems per page, 1 to 100. Default 25.
cursorquerystringnoAn opaque cursor from next_cursor. Pass it back unchanged.
MyDataHub-VersionheaderstringnoThe dated API version, pinned per key when left out. Non-breaking changes ship as new dates; the path major changes only for breaking changes, with a 12 month deprecation window.

Example request

curl "https://mydatahub.emailmovers.com/v1/events" \
  -H "Authorization: Bearer $MYDATAHUB_API_KEY"

Responses

200: A page of events.

Headers: RateLimit, RateLimit-Policy.

MemberTypeAlways presentDescription
dataarray of WebhookEventyes
has_morebooleanyesWhether another page follows.
next_cursorstring or nullyesPass as cursor to fetch the next page; null on the last page.

Example response

{
  "data": [
    {
      "id": "evt_01JB4NB7T1Y5W8ZAK8Q2V7XN3M",
      "type": "order.ready",
      "timestamp": "2026-09-26T10:16:04Z",
      "api_version": "2027-01-15",
      "data": {
        "order_id": "ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E",
        "records": 5000,
        "records_url": "/v1/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/records",
        "receipt_url": "/v1/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/receipt"
      }
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

Every error is a problem object with a code and a next_step. Every response carries the RateLimit and RateLimit-Policy headers; see Rate limits.

StatusProblem codesWhen
400invalid-request, idempotency-key-required, unsupported-versionThe request could not be read, or an Idempotency-Key is missing.
401authentication-required, account-requiredSign in (OAuth) or send an API key (authentication-required), or create a free account for what the anonymous tier does not cover (account-required).
403insufficient-scope, confirmation-required, business-details-required, licence-acceptance-required, dpa-acceptance-required, agent-budget-exceededThe token lacks a scope (insufficient-scope, with required_scope and a WWW-Authenticate step-up challenge); no person confirmed the spend and no agent key covers it (confirmation-required, with an approval_url); an agent key's per-order cap or monthly budget does not cover it (agent-budget-exceeded); an account made by self-serve sign-up has not yet confirmed its business name and that it is a UK business, which its first order needs (business-details-required); the order needs the Data Licence and Sharing Agreement accepted at the version in force (licence-acceptance-required); or a suppression upload comes before the organisation has accepted the Article 28 data processing agreement in force (dpa-acceptance-required). Nothing is charged.
422validation-failed, quote-required, dataset-unavailableThe request is not valid. errors lists every problem with a JSON pointer and did_you_mean.
429rate-limitedToo many requests. Wait for Retry-After.
Any other failureinternal-error, service-unavailable, tps-screen-expiredSomething failed on our side (500 internal-error) or the service is briefly unavailable (503 service-unavailable, with Retry-After). Nothing was charged; retry with the same Idempotency-Key. A count, sample, quote or order with telephone in play is also refused with 503 tps-screen-expired, with no Retry-After, while the dataset version's TPS and CTPS screen is more than 28 days old.