unsend icon indicating copy to clipboard operation
unsend copied to clipboard

docs: add PHP getting started guide

Open KMKoushik opened this issue 4 weeks ago • 3 comments

Summary

  • add a PHP getting-started guide that uses the REST API for sending emails and managing contacts
  • document setup with Guzzle, email sending, contact operations, and basic error handling
  • surface the PHP guide in the Getting Started navigation

Issues

  • None

Screenshots

  • Not applicable

Migrations

  • None

Verification

  • Not run (docs-only change)

Codex Task


Summary by cubic

Adds a PHP getting started guide that uses the REST API via Guzzle to send emails and manage contacts, and surfaces it in the Getting Started navigation.

  • New Features
    • Setup with Composer/Guzzle and a reusable client.
    • Examples for sending emails and creating/updating contacts.
    • Basic error handling patterns.
    • Added “PHP (API)” to the Getting Started nav.

Written for commit 45c89cbc3464ec7e68cc3ae8a6d066df48675108. Summary will update automatically on new commits.

Summary by CodeRabbit

  • Documentation
    • Added PHP Getting Started guide covering REST API integration with code examples for email sending and contact management
    • Updated documentation navigation to include the new PHP guide

✏️ Tip: You can customize this high-level summary in your review settings.

KMKoushik avatar Nov 29 '25 04:11 KMKoushik

Deploying usesend with  Cloudflare Pages  Cloudflare Pages

Latest commit: 45c89cb
Status: ✅  Deploy successful!
Preview URL: https://dc0e6045.usesend.pages.dev
Branch Preview URL: https://codex-create-getting-started.usesend.pages.dev

View logs

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
unsend-marketing Ready Ready Preview Comment Nov 29, 2025 4:42am

vercel[bot] avatar Nov 29 '25 04:11 vercel[bot]

Walkthrough

This pull request adds PHP documentation to the Getting Started section. It includes a new page in the documentation navigation (docs.json) and introduces a comprehensive PHP guide (get-started/php.mdx) for using the useSend REST API. The guide covers prerequisites, Guzzle HTTP client installation and configuration, practical examples for sending emails and managing contacts using POST and PATCH requests, error handling with try/catch blocks, and support notes for self-hosted deployments. Custom header forwarding is also documented.

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add PHP getting started guide' clearly and concisely describes the main change: adding a PHP getting-started guide to the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot] avatar Nov 29 '25 04:11 coderabbitai[bot]