postalserver / postalserver/postal

Documentation for webhooks

Open
#294 2 comments 0 reactions 0 assignees View on GitHub
docs
Dominant language
Ruby
Stars
16.8k
Forks
1.3k
Avg merge
13d 7h
Merged PRs (30d)
2

Description

The sample payloads for the various webhooks don't appear to be up-to-date. For example, the Sent example is using `status` where it should be `event`. The MessageBounced example is missing `event`, `timestamp` etc, as well as the wrapping `payload` key.

Contributor guide

Open the contributing guide

Research direction

Locate the documentation containing the Sent and MessageBounced webhook sample payloads, then compare those examples with the webhook payload structure described in the issue. Update the examples to use the correct event fields and payload wrapper, and verify that the documented samples match the current webhook format.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.