Requirements

• An API method set up with the "Export — Export Webhook Logs" step.

To access the export file, you need the "Export integration logs" permission, which is usually granted to "Owners" by default.

General contract for export jobs

Please refer to this article for more detail on the general contract for export jobs.

Webhook logs export contract

Sample request

https://api.maestra.io/v3/operations/sync?endpointId={endpointId}&operation={operation}

Accept: application/json
Content-Type: application/json
Authorization: SecretKey {Secret Key}

{
  "exportId": "<Export ID>",
  "sinceDateTimeUtc": "<Webhook call start date and time (UTC, YYYY-MM-DD hh:mm)>",
  "tillDateTimeUtc": "<Webhook call end date and time exclusive (UTC, YYYY-MM-DD hh:mm)>",
  "isSuccessful": "<Completed successfully?>",
  "webhooks": [
    {
      "ids": {
        "id": "<Webhook ID>"
      }
    },
    {
      "ids": {
        "id": "<Webhook ID>"
      }
    }
  ]
}

The input parameters may specify:

• "From" date in UTC format. The export log will only include webhooks that were added after this date;
• "To" date in UTC format. The export log will only include webhooks that were added before this date;
• If the export file should include only successful or only failed calls;
• Webhook IDs included in their URL

Webhook log basic fields

• WebhookLogTransactionId: Unique webhook request ID. Remains the same within repeated attempts to send the webhook, i. e. idempotent.
• WebhookLogStartDateTimeUtc: Webhook UTC request time.
• WebhookLogWebhookSourceId: Unique ID of the flow node, from which the webhook is called. It includes the flow ID and the flow node ID.
• WebhookLogWebhookSourceType: Type of element, from which the webhook is called. Only the flow node is currently supported.
• WebhookLogWebhookSourceName: Name of element, from which the webhook is called.
• WebhookLogWebhookSourceUrl: Mechanics URL, from which the webhook is called.
• WebhookLogWebhookId: Unique webhook ID.
• WebhookLogWebhookName: Webhook name.
• WebhookLogIntegrationId: Unique webhook integration ID.
• WebhookLogIntegrationName: Webhook integration ID.
• WebhookLogStatus: Webhook request status: success or failure.
• WebhookLogHttpMethod: Webhook HTTP method.
• WebhookLogUrl: Webhook URL.
• WebhookLogRequestHeaders: Webhook request headers.
• WebhookLogRequestBody: Webhook request body.
• WebhookLogHTTPStatusCode: Webhook response code.
• WebhookLogResponseHeaders: Webhook response headers.
• WebhookLogResponseBody: Webhook response body.
• WebhookLogRetryNumber: Webhook request retry number.