Webhooks

Learn how to use webhooks to get alerts on subscriber and post events.

Checking for the API Key
We send a POST request to the webhook endpoints you specify. To verify that the request came from Letterdrop, check for a field in the header of the request with key api-key and make sure it matches the value in your Settings.
If the API Key is absent, you're getting hit up with requests from our evil twin from another dimension. Do not trust him under any circumstances!
New Post
Triggers when a new post is published.
Key
Value
Type
Title
Title of the post
String
Subtitle
Subtitle of the post
String
textBody
Post body in plain text
String
htmlBody
Post body in HTML
String
url
Post URL
String
publishedOn
Date post was published on
Date
type
Paid or free
String
Sample payload
{
  "title": "Title",
  "subtitle": "Subtitle",
  "textBody": "Lorem ipsum dolor sit amet,",
  "htmlBody": "<p>Lorem ipsum dolor sit amet,</p>",
  "url": "https://letterdop.co/@updates",
  "publishedOn": "2020-10-20T12:18:13.095Z",
  "type": "free"
}
Subscriber Added
Triggers when a new email was added to your subscriber list.
Key
Value
Type
email
Email of subscriber
String
signedUpOn
Date user subscribed on
Date
planType
Paid or free
String
Sample payload
{
  "email": "[email protected]",
  "signedUpOn": "2020-10-20T12:07:13.629Z",
  "planType": "paid"
}
Subscriber Removed
Triggers when an email was removed from your subscriber list.
Key
Value
Type
email
Email of subscriber
String
unsubscribedOn
Date user unsubscribed on
Date
planType
Paid or free
String
Sample payload
{
  "email": "[email protected]",
  "unsubscribedOn": "2020-10-20T12:07:13.629Z",
  "planType": "paid"
}
Referral Tier Achieved
Triggers when a subscriber makes enough referrals to unlock a new level in your referral tiers.
Key
Value
Type
email
Email of subscriber
String
unsubscribedOn
Date user unsubscribed on
Date
planType
Paid or free
String
Sample payload
{
  "email": "[email protected]",
  "unsubscribedOn": "2020-10-20T12:07:13.629Z",
  "planType": "paid"
}

Finding and using your API key

API Endpoints

Last updated 4 months ago

Key	Value	Type
Title	Title of the post	String
Subtitle	Subtitle of the post	String
textBody	Post body in plain text	String
htmlBody	Post body in HTML	String
url	Post URL	String
publishedOn	Date post was published on	Date
type	Paid or free	String

Key	Value	Type
email	Email of subscriber	String
signedUpOn	Date user subscribed on	Date
planType	Paid or free	String