Letterdrop
Search…
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!
Post published, updated, or deleted
Triggers when a new post is published.
Key
Value
Type
id
Post ID
String
title
Title of the post
String
subtitle
Subtitle of the post
String
body
Post body in HTML
String
text
An example of the post body in plain text with a restricted number of characters
String
textPreview
A short example of the plain text of the post body
String
author
Post author's name and profile picture
JSON Object
tags
List of tags
List
coverImage
Cover photo URL
String
slug
User-friendly string identifier of the post
String
url
URL of post
String
shareLink
Thumbnail image URL and social description
JSON Object
publishedOn
Date post was published on
Date
updated
Date post was updated on
Date
status
Whether the post is
published or updated or deleted.String
type
Type of the post
free or paid String
publication
Name of the publication that published the post
String
isPrivate
Whether the post is visible on blog
Boolean
featured
Whether the post is featured on blog
Boolean
Sample payload
1
{
2
"id": "6030dc61a21da91db1d593c0",
3
"title": "Title",
4
"subtitle": "Subtitle",
5
"body": "<p>Lorem ipsum dolor sit amet,</p>",
6
"text": "Lorem ipsum dolor sit amet,",
7
"textPreview": "Lorem ipsum dolor sit amet,",
8
"author": {
9
"name": "Letterdrop",
10
"avatar": "https://letterdrop.com/images/logo.svg"
11
},
12
"tags": ["chocolate", "food", "restaurant"],
13
"coverImage": "https://app.letterdrop.com/resources/images/default_cover_photo.jpg",
14
"slug": "title",
15
"url": "https://letterdop.com/@updates/my-new-post",
16
"shareLink": {
17
"thumbnail": "https://app.letterdrop.com/resources/images/thumbnail.jpg",
18
"description": "thumbnail description"
19
},
20
"publishedOn": "2020-10-20T12:18:13.095Z",
21
"updated": "",
22
"status": "published",
23
"type": "free",
24
"publication": "letterdrop",
25
"isPrivate": false,
26
"featured": false,
27
"readTime": 0.30,
28
"wordCount": 60
29
}
Copied!
​
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
Sample payload
Copied!
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
Sample payload
Copied!
Subscriber updated
Triggers when a subscriber is updated.
Key
Value
Type
email
Email of subscriber
String
field
Updated field
String
value
New value of the field
String
Sample payload
Copied!
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
Sample payload
Copied!
Last modified 3mo ago