Notifications

This page will help you retrieve notifications with the Beambox API

Retrieve All Notifications

Use this endpoint to retrieve all your notifications. By default, the response will be limited to 100 notifications, you can include the limit and offset variables to make multiple requests if you have over 100 notifications.

Replace YOUR_API_KEY_HERE with your Beambox API key. You can find this on the integrations page of your Beambox account.

Ruby

HTTParty.get("https://beambox.com/api/v1/YOUR_API_KEY_HERE/notifications", body: {limit: 2, offset: 0})

Response

[
    {
        "id": 9106902,
        "human": "Joe Bloggs",
        "human_id": 981632,
        "phrase": "Joe Bloggs was imported to your guest database",
        "location": "Location 2"
    },
    {
        "id": 9106901,
        "human": "Api",
        "human_id": 981631,
        "phrase": "Api was imported to your guest database",
        "location": "Location 5"
    }
]

Retrieve A Notification

Use this endpoint to retrieve the details of a single notification. The notification ID is a required parameter.

Replace YOUR_API_KEY_HERE with your Beambox API key. You can find this on the integrations page of your Beambox account.

Replace NOTIFICATION_ID_HERE with the ID of the notification you want to retrieve.

Ruby

HTTParty.get("https://beambox.com/api/v1/YOUR_API_KEY_HERE/notification/NOTIFICATION_ID_HERE")

Response

{
    "id": 9106902,
    "human": "Joe Bloggs",
    "human_id": 981632,
    "phrase": "Joe Bloggs was imported to your guest database",
    "location": "Location 2"
}