Reference

API reference

Every endpoint, generated from the same spec the API is built from. If it is on this page, it is routed; if it is routed, it is on this page.

Incidents

POST/v1/integrations/alertmanager/{configurationId}/{escalationPolicyId}/{sourceId}

Receive Prometheus Alertmanager events

GET/v1/incidents

List incidents

GET/v1/incidents/{id}

Get an incident

POST/v1/incidents/{id}

Acknowledge or resolve an incident

POST/v1/alerts

Ingest an alert

Emails

POST/v1/emails

Send an email

POST/v1/attachments

Create an attachment upload

Analytics

GET/v1/analytics

Daily email totals

Contacts

GET/v1/contacts

List contacts

POST/v1/contacts

Create or update a contact

Suppressions

GET/v1/suppressions

List suppressions

POST/v1/suppressions

Create or import suppressions

DELETE/v1/suppressions/{id}

Remove a suppression

Audiences

GET/v1/audiences

List audiences

POST/v1/audiences

Create an audience

Campaigns

GET/v1/campaigns

List campaigns

POST/v1/campaigns

Create and start a campaign

Templates

GET/v1/templates

List templates

POST/v1/templates

Create a template

GET/v1/templates/{id}

Retrieve a template

PATCH/v1/templates/{id}

Update a template

DELETE/v1/templates/{id}

Delete a template

SMS

POST/v1/sms

Send an SMS

GET/v1/sms

List SMS messages

GET/v1/sms/{id}

Retrieve an SMS message

Webhooks

GET/v1/webhooks

List webhook endpoints

POST/v1/webhooks

Create a webhook endpoint

PATCH/v1/webhooks/{id}

Update a webhook endpoint

DELETE/v1/webhooks/{id}

Disable a webhook endpoint

Compatibility

POST/emails

Send an email, Resend-shaped

POST/emails/batch

Send a batch of emails, Resend-shaped

POST/v3/mail/send

Send an email, SendGrid-shaped

The machine-readable description lives at api.transmit.dev/openapi.json.