Webhook

Integration

Your webhook must be publicly available and be secure. Birch will not deliver logs to an endpoint without SSL/TLS.

The endpoint should return 200-299 status code to signal that the logs were received, any other response will queue the logs for retry.

Birch

Add the integration to your dashboard.

Securing your endpoint

There are 2 options for securing your endpoint:

1. Basic Authentication
2. Query Parameters

Basic Authentication

You can format your url as follows:

https://username:password@your_domain.com/endpoint

Query Params

You can format your url as follows:

https://your_domain.com/endpoint?access_token=your_access_token

Log Format

[
  {
    "timestamp": "2022-10-25T02:05:15+00:00",
    "level": 0,
    "source": {
      "uuid": "954257b7-1feb-4fd1-8cb8-a047a105ff26",
      "package_name": "com.gruffins.birch.app",
      "app_version": "1.0",
      "app_build_number": "1",
      "brand": "google",
      "manufacturer": "google",
      "model": "pixel 3a",
      "os": "Android",
      "identifier": "user_id",
      "custom_property__key": "value",
      "custom_property__key_1": "value 1"
    },
    "message": "hello"
  }
]