Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Message Attempt

Get Attempt

msg_id: Use a message id or a message eventId

get/api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}

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.

attempt_idstring required

The MessageAttempt's ID.

Example:atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2

The MessageAttempt's ID.

Query parameters

expanded_statusesboolean

When true, return the Canceled (4) status in attempts.

If false, canceled attempts are returned as Success (0) for backwards compatibility.

When true, return the Canceled (4) status in attempts.

If false, canceled attempts are returned as Success (0) for backwards compatibility.

Response

urlstring uri required
responsestring required
responseStatusCodeinteger required
responseDurationMsinteger required

Response duration in milliseconds.

status0 | 1 | 2 | 3 | 4 required

The sending status of the message:

  • Success = 0
  • Pending = 1
  • Fail = 2
  • Sending = 3
  • Canceled = 4
statusText'success' | 'pending' | 'fail' | 'sending' | 'canceled' required
triggerType0 | 1 required

The reason an attempt was made:

  • Scheduled = 0
  • Manual = 1
msgIdstring required

The Message's ID.

endpointIdstring required

The Endpoint's ID.

idstring required

The MessageAttempt's ID.

timestampstring date-time required

Example response

{
  "url": "https://example.com/webhook/",
  "response": "{}",
  "responseStatusCode": 200,
  "msgId": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "endpointId": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "id": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "msg": {
    "eventId": "unique-identifier",
    "eventType": "user.signup",
    "payload": {
      "type": "user.created",
      "email": "test@example.com",
      "username": "test_user"
    },
    "channels": [
      "project_123",
      "group_2"
    ],
    "id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
    "tags": [
      "project_1337"
    ]
  }
}