Testing & Monitoring a Webhook

Testing a Webhook

Once a webhook has been created, it can be manually tested via:
POST https://api.getguru.com/api/v1/webhooks/{webhookId}/test

The body of the request should be an event which matches the format of an event which would be delivered by the webhook.

Example Request

{
    "id":"64753163-9817-4500-9651-96177c32e3d1",
    "eventType":"card-created",
    "user":"[email protected]",
    "eventDate":"2021-04-13T13:53:00.000+0000"
}

Monitoring a Webhook

Webhooks will generate emails to the owner when important errors occur (e.g. dropped events due to undeliverability). Additionally, the current logs (kept for at most 2 weeks) associated with a webhook can be retrieved via:
GET https://api.getguru.com/api/v1/webhooks/{webhookId}/logs

The results are returned newest to oldest with at most 50 per page (they can be paged using the standard guru server API paging mechanism). The request supports the optional query parameters startDate and endDate to get logs for a specific time frame.

Example Response

[
    {
        "level": "ERROR",
        "message": "[404] Webhook operation failed (post operation returned unexpected code); statusCode = 404",
        "timestamp": "2021-05-19T14:25:57.974+0000"
    },
    {
        "level": "ERROR",
        "message": "[404] Webhook operation failed (post operation returned unexpected code); statusCode = 404",
        "timestamp": "2021-05-19T14:25:12.547+0000"
    }
]