All Event Logs

Introduction

The logs endpoint provides comprehensive access to all event types logged by your WhatsApp Business Account. By omitting the eventTypes parameter, you can retrieve a complete view of all activities including incoming messages, message status updates, and other events within your specified time range.

This is particularly useful for comprehensive monitoring, auditing, and building complete activity dashboards.

Key Features

Complete Event Coverage: Retrieves all event types in a single request

Unified View: See incoming messages, status updates, and other events together

Time-Based Filtering: Filter by date range using Ticks format (optional)

Optional Filters: Narrow results by phone number ID or webhook URL

7-Day Retention: Logs are available for the last 7 days only

Request Parameters

Optional Parameters

Parameter	Type	Description
`fromDate`	integer	Start date in Ticks format (100-nanosecond intervals since January 1, 0001 UTC). If omitted, retrieves logs from the beginning of available data.
`toDate`	integer	End date in Ticks format. If omitted, retrieves logs up to the current time.
`phoneNumberId`	string	Filter logs for a specific WhatsApp Business phone number ID
`url`	string	Filter logs for a specific webhook URL (must be URL encoded)
`pageSize`	integer	Number of log entries to return per page. Default: 20, Maximum: 20
`nextPageToken`	string	Token for pagination to retrieve the next page of results. Use the `next_page_token` value from the previous response.

Date Format

The fromDate and toDate parameters use Ticks format, representing 100-nanosecond intervals since January 1, 0001 at 00:00:00 UTC.

Example: 638000000000000000 represents a specific timestamp in this format.

Request Examples

Basic Request (All Events)

Retrieve all logs without date filters:

Or with date range:

Filter by Phone Number ID

Filter by Webhook URL

Response Example

{
    "message": "Notification logs retrieved successfully",
    "data": {
        "logs": [
            {
                "project_id": "12345",
                "phone_number_id": "123456789012345",
                "event_type": "Message Status",
                "payload": "{\"object\":\"whatsapp_business_account\",\"entry\":[{\"id\":\"123456789012345\",\"changes\":[{\"field\":\"messages\",\"value\":{\"messaging_product\":\"whatsapp\",\"metadata\":{\"display_phone_number\":\"15551234567\",\"phone_number_id\":\"123456789012345\"},\"statuses\":[{\"id\":\"msg_ABC123XYZ\",\"recipient_id\":\"1234567890\",\"status\":\"failed\",\"timestamp\":\"1704067200\",\"errors\":[{\"code\":132001,\"title\":\"(#132001) Template name does not exist in the translation\",\"message\":\"(#132001) Template name does not exist in the translation\",\"error_data\":{\"details\":\"template name (Appointment Reminders) does not exist in en_US\"}}]}]}}]}]}",
                "created_at": 638500000000000000,
                "direction": 1,
                "flyout_delivery_status": "-",
                "flyout_delivery_response": "-",
                "flyout_delivery_response_code": 0,
                "flyout_url": "-"
            },
            {
                "project_id": "12345",
                "phone_number_id": "123456789012345",
                "event_type": "Incoming Message",
                "payload": "{\"object\":\"whatsapp_business_account\",\"entry\":[{\"id\":\"123456789012345\",\"changes\":[{\"field\":\"messages\",\"value\":{\"messaging_product\":\"whatsapp\",\"metadata\":{\"display_phone_number\":\"15551234567\",\"phone_number_id\":\"123456789012345\"},\"contacts\":[{\"wa_id\":\"1234567890\",\"profile\":{\"name\":\"John Doe\"}}],\"messages\":[{\"from\":\"1234567890\",\"id\":\"wamid.HBgMDEyMzQ1Njc4OTAFQIAEhgWM0VCMDI5NTg3MDU0MDIxQUVCMzA0RgA=\",\"timestamp\":\"1704067200\",\"type\":\"text\",\"text\":{\"body\":\"Hello, this is a test message\"}}]}}]}]}",
                "created_at": 638500000100000000,
                "direction": 1,
                "flyout_delivery_status": "-",
                "flyout_delivery_response": "-",
                "flyout_delivery_response_code": 0,
                "flyout_url": "-"
            }
        ],
        "next_page_token": "eyJQcm9qZWN0SWQiOnsiTiI6IjEyMzQ1In0sIkNyZWF0ZWRBdCI6eyJOOiI2Mzg1MDAwMDAwMDAwMDAwMCJ9fQ=="
    }
}

Response Fields

Top-Level Fields

message (string): Success message indicating the operation result

data (object): Container for the response data

Data Object

data.logs (array): Array of log entries matching the query criteria

data.next_page_token (string): Token for pagination to retrieve the next page

Log Entry Fields

Each log entry in the logs array contains:

Field	Type	Description
`project_id`	string	The project identifier
`phone_number_id`	string	The WhatsApp Business phone number ID
`event_type`	string	Type of event: "Incoming Message", "Message Status", or "Other"
`payload`	string	JSON string containing the full webhook payload
`created_at`	integer	Timestamp in Ticks format when the log entry was created
`direction`	integer	Message direction (1 = incoming)
`flyout_delivery_status`	string	Delivery status for flyout notifications
`flyout_delivery_response`	string	Delivery response for flyout notifications
`flyout_delivery_response_code`	integer	HTTP response code for flyout delivery
`flyout_url`	string	URL for flyout notifications

Event Types Included

When retrieving all logs, the response may include:

Incoming Message: Messages received by your WhatsApp Business number

Message Status: Status updates for sent messages (sent, delivered, read, failed)

Other: Other event types not covered by the above categories

Pagination

When there are more results available, the response includes a next_page_token. To retrieve the next page, include the nextPageToken parameter in your request:

Continue this process until no next_page_token is returned in the response.

Error Handling

400 Bad Request

{
    "message": "Invalid request parameters",
    "data": null
}

401 Unauthorized

{
    "message": "Unauthorized"
}

403 Forbidden

{
    "message": "Forbidden"
}

500 Internal Server Error

{
    "message": "Internal server error",
    "data": null
}

Important Notes

⚠️ Log Retention: Logs are only available for the last 7 days

📦 Payload Format: The payload field is a JSON string that must be parsed

🔢 Timestamp Format: All timestamps use Ticks format

🔍 Filtering: Use phoneNumberId or url to narrow results

📄 Pagination: Always check for next_page_token to retrieve all results

Use Cases

Complete Activity Monitoring: View all events across your WhatsApp Business Account

Audit Trails: Maintain comprehensive logs of all activities

Dashboard Building: Create unified dashboards showing all event types

Troubleshooting: Review all events to identify patterns or issues

Analytics: Analyze complete activity patterns across different event types

Code Example

Retrieve Incoming Message Logs - Filter for incoming messages only

Retrieve Message Status Logs - Filter for status updates only

Retrieve Other Event Logs - Filter for other event types

Retrieve Multiple Event Types - Filter for specific multiple event types

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Introduction#

Key Features#

Request Parameters#

Optional Parameters#

Date Format#

Request Examples#

Basic Request (All Events)#

Filter by Phone Number ID#

Filter by Webhook URL#

Response Example#

Response Fields#

Top-Level Fields#

Data Object#

Log Entry Fields#

Event Types Included#

Pagination#

Error Handling#

400 Bad Request#

401 Unauthorized#

403 Forbidden#

500 Internal Server Error#

Important Notes#

Use Cases#

Code Example#

Related Endpoints#

Request

Responses