Skip to main content
GET
/
activity
/
events
Ruby
Helo.configure do |config|
  config.access_token = "YOUR_BEARER_TOKEN"
end

opts = {
  channel_id: "550e8400-e29b-41d4-a716-446655440000",
  message_id: "550e8400-e29b-41d4-a716-446655440000",
  after: 10,
  start_date: "2024-01-01T00:00:00Z",
  end_date: "2024-01-01T00:00:00Z",
  limit: 10,
  recipient: "example",
  subject: "example",
  tags: ["example1", "example2"],
  mail_type: "transactional",
  event_types: ["accepted", "processed"]
}
Helo::Activity.list_events(opts)
{
  "totalCount": 123,
  "results": [
    {
      "messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timestamp": "2023-11-07T05:31:56Z",
      "subject": "<string>",
      "recipients": [
        "<string>"
      ],
      "tags": [
        "<string>"
      ],
      "metadata": {},
      "details": {}
    }
  ],
  "after": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

channelId
string<uuid>
messageId
string<uuid>
after
integer<int64>
startDate
string<date-time>
endDate
string<date-time>
limit
integer
Required range: x <= 500
recipient
string
subject
string
tags
string[]
mailType
enum<string>
Available options:
transactional,
broadcast
eventTypes
enum<string>[]
Available options:
accepted,
processed,
delivered,
bounced,
opened,
clicked,
complained,
unsubscribed,
resubscribed

Response

OK

totalCount
number
required
results
object[]
required
after
integer<int64>