Message Attempt

List Attempted Destinations

List endpoints attempted by a given message.

Additionally includes metadata about the latest message attempt. By default, endpoints are listed in ascending order by ID.

get/api/v1/app/{app_id}/msg/{msg_id}/endpoint

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

msg_idstring required

The Message's ID or UID.

Example:unique-identifier

The Message's ID or UID.

Query parameters

limitinteger

Limit the number of returned items

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

Example:ep_1srOrx2ZWZBpBUvZwXKQmoEYga2

The iterator returned from a prior invocation

Response

doneboolean required
iteratorstring nullable required
prevIteratorstring nullable

Example response

{
  "data": [
    {
      "channels": [
        "project_123",
        "group_2"
      ],
      "eventTypes": [
        "user.signup",
        "user.deleted"
      ],
      "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "uid": "unique-identifier",
      "url": "https://example.com/webhook/"
    }
  ],
  "iterator": "iterator",
  "prevIterator": "-iterator"
}

Changes

Changed in 2 of the 5 revisions of this API.122

  • dc130bd1b074121See the full diff
    • removed the required property data/items/version from the response with the 200 status

      response-required-property-removed

    • removed the optional property data/items/filterTypes from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/rateLimit from the response with the 200 status

      response-optional-property-removed

    • added the optional property data/items/eventTypes to the response with the 200 status

      response-optional-property-added

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the required property data/items/version to the response with the 200 status

      response-required-property-added

    This revision also has 157 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog