Skip to main content

API Structure

The Sendly SDK is organized into resources, each with its own methods:

Main Resources

Emails

Manage email sending and tracking. Use cases:
  • Send transactional emails
  • Track deliveries
  • Manage bounces
  • Monitor opens and clicks

Domains

Configure and verify sending domains. Use cases:
  • Add your own domain
  • Configure DNS records
  • Verify authenticity
  • Enable tracking

Webhooks

Receive real-time event notifications. Use cases:
  • Delivery notifications
  • Bounce alerts
  • Status updates
  • Click and open events

Logs

Access a historical record of all requests. Use cases:
  • Sending audits
  • Debugging issues
  • Usage analytics

Authentication

All requests require authentication with an API key:

Response Format

Successful Response

Error Response

Error Handling

Rate Limiting

  • Limit: 1000 requests per minute
  • Response headers:
    • X-RateLimit-Limit: Total limit
    • X-RateLimit-Remaining: Remaining requests
    • X-RateLimit-Reset: Reset timestamp

Pagination

List responses include pagination information:

Idempotency

For critical operations like sending emails, use idempotency keys:

Timeouts

  • Connection timeout: 30 seconds
  • Read timeout: 60 seconds

Base Endpoints

  • API: https://api.usesendly.app/v1
  • Dashboard: https://app.usesendly.com

Versions

We are currently on v1 of the API. Changes will be announced in advance.

Support

Need help? Contact support@usesendly.app