Skip to content

docs: add API usage examples for NotifyChain workflows - #901

Merged
Abd-Standard merged 1 commit into
Core-Foundry:mainfrom
pelumixxril:fix/issue-868-add-api-usage-examples
Oct 2, 2026
Merged

Abd-Standard merged 1 commit into
Core-Foundry:mainfrom
pelumixxril:fix/issue-868-add-api-usage-examples

Conversation

@pelumixxril

Copy link
Copy Markdown
Contributor

Overview

This PR adds practical API usage examples for common NotifyChain workflows, giving developers copy-paste-ready snippets for creating, scheduling, querying, and monitoring notifications, plus guidance on handling API errors.

Related Issue

Changes

📚 API Usage Examples

  • [ADD] docs/API_USAGE_EXAMPLES.md
    • Creating notifications — request/response example for sending a notification.
    • Scheduling notifications — example of scheduling a notification for a future time.
    • Querying event history — example of retrieving past notification events.
    • Checking delivery status — example of looking up the delivery status of a notification.
    • Handling API errors — example error responses and recommended handling patterns.

Verification Results

Docs-only change:
✅ Examples reviewed for consistency with existing API conventions
✅ All five requested workflows covered (create, schedule, query, status, errors)
Acceptance Criteria Status
Creating notifications example included ✅ Documented with request/response
Scheduling notifications example included ✅ Documented with request/response
Querying event history example included ✅ Documented with request/response
Checking delivery status example included ✅ Documented with request/response
Handling API errors example included ✅ Documented with error responses and handling guidance

Closes #868

@drips-wave

drips-wave Bot commented Sep 30, 2026

Copy link
Copy Markdown

@pelumixxril Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Abd-Standard
Abd-Standard merged commit 958818d into Core-Foundry:main Oct 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add API Usage Examples

2 participants