Get Message Logs

List message log entries

GET/v1/message_logs

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Message Logs action (under management).
Fill in the fields below, then reference the result from later steps as {{getMessageLogs.response.data}}.

Request

Query parameters

messageIDstring

Filter results by message ID.

changeTypestring

Filter results by change type.

One ofCampaignEvaluationTreeChangedCampaignNotificationCouponCreatedCouponUpdatedCouponDeletedAsyncCouponsCreatedCouponsDeletedCouponsUpdatedCouponCodeExpiringStrikethroughPriceLoyaltyPointsAddedLoyaltyPointsDeductedLoyaltyPointsExpiringLoyaltyPointsPendingToActiveLoyaltyAddedDeductedPointsBalancesLoyaltyCardAddedDeductedPointsBalancesTierWillDowngradeTierUpgradeTierDowngradeLoyaltyCardPointsAddedLoyaltyCardPointsDeductedLoyaltyCardPointsExpiring

notificationIDsstring

Filter results by notification ID (include up to 30 values, separated by a comma).

createdBeforestring (date-time)

Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. Use UTC time.

createdAfterstring (date-time)

Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. Use UTC time.

cursorstring (byte)

A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.

periodstring

Filter results by time period. Choose between the available relative time frames.

One of15m30m1h4h1d2d

isSuccessfulboolean

Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to`true`, only log entries with `2xx` response codes are returned. When set to `false`, only log entries with `4xx` and `5xx` response codes are returned.

entityTypestringrequired

The entity type the log is related to.

One ofapplicationloyalty_programwebhook

applicationIdnumber

Filter results by Application ID.

campaignIdnumber

Filter results by campaign ID.

loyaltyProgramIdinteger (int64)

Identifier of the loyalty program.

responseCodeinteger (int64)

Filter results by response status code.

webhookIDsstring

Filter results by webhook ID (include up to 30 values, separated by a comma).

Response

Returns 200 with an object. Read it in later steps with {{getMessageLogs.response.data.<field>}}.

nextCursorstring (byte)

The next value in the database. **Note:** If this value is not present, it means that there are no more values in the database for this combination of request parameters.

dataarray<object>

List of message logs.

idstringrequired

Unique identifier of the message.

servicestringrequired

Name of the service that generated the log entry.

changeTypestring

Type of change that triggered the notification.

notificationIdinteger (int64)

ID of the notification.

notificationNamestring

The name of the notification.

webhookIdinteger (int64)

ID of the webhook.

webhookNamestring

The name of the webhook.

requestobject2 fields

Details of the request.

responseobject3 fields

Details of the response.

createdAtstring (date-time)required

Timestamp when the log entry was created.

entityTypestringrequired

The entity type the log is related to.

One ofapplicationloyalty_programwebhook

urlstring

The target URL of the request.

applicationIdinteger (int64)

Identifier of the Application.

loyaltyProgramIdinteger (int64)

Identifier of the loyalty program.

campaignIdinteger (int64)

Identifier of the campaign.

json

{
  "data": [
    {
      "request": {
        "createdAt": {},
        "request": "SGVsbG8sIHdvcmxkIQ=="
      },
      "webhookId": 101,
      "entityType": "loyalty_program",
      "campaignId": 2,
      "changeType": "Update",
      "url": "www.my-company.com/my-endpoint-name",
      "createdAt": {},
      "service": "NotificationService",
      "response": {
        "createdAt": {},
        "response": "UmVzcG9uc2UgY29udGVudA==",
        "status": 200
      },
      "webhookName": "My webhook",
      "notificationId": 101,
      "loyaltyProgramId": 2,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "applicationId": 5,
      "notificationName": "My campaign notification"
    }
  ],
  "nextCursor": "SmJlNERRMHdyNWFsTmRDZDVYU0c="
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?