https://github.com/marcl/messenger-json-schema
JSON schema for Messenger messages
https://github.com/marcl/messenger-json-schema
Last synced: 6 months ago
JSON representation
JSON schema for Messenger messages
- Host: GitHub
- URL: https://github.com/marcl/messenger-json-schema
- Owner: MarcL
- License: mit
- Created: 2019-06-30T21:24:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T03:52:43.000Z (about 3 years ago)
- Last Synced: 2025-07-12T19:46:57.294Z (6 months ago)
- Language: JavaScript
- Size: 757 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# messenger-json-schema
> WIP: JSON schema for Messenger messages
## Install
```
npm -i messenger-json-schema
```
```
yarn add messenger-json-schema
```
## Format
Provides schemas for JSON formatted [Facebook Messenger messages](https://developers.facebook.com/docs/messenger-platform/send-messages). Validates against JSON schema using [ajv](https://github.com/epoberezkin/ajv) format.
## Supported Messages
https://developers.facebook.com/docs/messenger-platform/reference/send-api/
|Message type|Implemented|
|---|:---:|
|[Text](https://developers.facebook.com/docs/messenger-platform/send-messages#sending_text)|:white_check_mark:|
|[Attachment](https://developers.facebook.com/docs/messenger-platform/send-messages#sending_attachments)|:white_check_mark:|
|[Quick reply: Email](https://developers.facebook.com/docs/messenger-platform/send-messages/quick-replies#email)|:white_check_mark:|
|[Quick reply: Phone number](https://developers.facebook.com/docs/messenger-platform/send-messages/quick-replies#phone)|:white_check_mark:|
|[Quick reply: Text](https://developers.facebook.com/docs/messenger-platform/send-messages/quick-replies#text)|:white_check_mark:|
|[Template: Generic](https://developers.facebook.com/docs/messenger-platform/send-messages/template/generic)|:x:|
|[Template: Button](https://developers.facebook.com/docs/messenger-platform/send-messages/template/button)|:x:|
|[Template: Receipt](https://developers.facebook.com/docs/messenger-platform/send-messages/template/receipt)|:x:|
|[Template: Media](https://developers.facebook.com/docs/messenger-platform/send-messages/template/media)|:x:|
|[Button: URL](https://developers.facebook.com/docs/messenger-platform/send-messages/buttons#url)|:x:|
|[Button: Postback](https://developers.facebook.com/docs/messenger-platform/send-messages/buttons#postback)|:x:|
|[Button: Call](https://developers.facebook.com/docs/messenger-platform/send-messages/buttons#call)|:white_check_mark:|
|[Button: Login](https://developers.facebook.com/docs/messenger-platform/send-messages/buttons#login)|:x:|
|[Button: Logout](https://developers.facebook.com/docs/messenger-platform/send-messages/buttons#logout)|:x:|
|[Button: Game Play](https://developers.facebook.com/docs/messenger-platform/send-messages/buttons#game_play)|:x:|
## Notes
This schema validates against the changes from June 10, 2019.
## References
[Understanding JSON Schema](https://json-schema.org/understanding-json-schema/index.html)
[Messenger Changelog](https://developers.facebook.com/docs/messenger-platform/changelog/)