Letterdrop
Search…
Letterdrop
Letterdrop API Docs
Finding and using your API key
Webhooks
API Endpoints
Powered By GitBook
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
readTime
Time takes to read the post in minutes
Double
wordCount
Number of words in the post
Integer
markdown
Post body in Markdown
String

Sample payload

{
"id": "6030dc61a21da91db1d593c0",
"title": "Title",
"subtitle": "Subtitle",
"body": "<p>Lorem ipsum dolor sit amet,</p>",
"text": "Lorem ipsum dolor sit amet,",
"textPreview": "Lorem ipsum dolor sit amet,",
"author": {
"name": "Letterdrop",
"avatar": "https://letterdrop.com/images/logo.svg"
},
"tags": ["chocolate", "food", "restaurant"],
"coverImage": "https://app.letterdrop.com/resources/images/default_cover_photo.jpg",
"slug": "title",
"url": "https://letterdop.com/@updates/my-new-post",
"shareLink": {
"thumbnail": "https://app.letterdrop.com/resources/images/thumbnail.jpg",
"description": "thumbnail description"
},
"publishedOn": "2020-10-20T12:18:13.095Z",
"updated": "",
"status": "published",
"type": "free",
"publication": "letterdrop",
"isPrivate": false,
"featured": false,
"readTime": 0.30,
"wordCount": 60,
"markdown": "Lorem ipsum dolor sit amet,"
}
​

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

{
"email": "[email protected]",
"signedUpOn": "2020-10-20T12:07:13.629Z"
}

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

{
"email": "[email protected]",
"unsubscribedOn": "2020-10-20T12:07:13.629Z"
}

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

{
"email": "[email protected]",
"field": "name",
"value": "john"
}

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

{
"email": "[email protected]",
"unsubscribedOn": "2020-10-20T12:07:13.629Z"
}

Project created or updated

Triggers when a project is created or updated.
Key
Value
Type
title
Project title
String
description
Project description
String
labels
List of labels
List
keyword
Keyword associated with project
String
status
Project status
String
suggestedBy
Email of the user who suggested the idea
String
suggestedOn
Date idea was suggested on
Date
assignedBy
Email of the user who assigned the project
String
assignedTo
Email of the user who will work on the project
String
contributors
List of emails of users who can contribute to the project
List
contentMapDeadline
Content Map deadline
Date
editorApprovers
List of email of editor approvers
List
editorDeadline
Editorial review deadline
Date
approvers
List of emails of approvers
List
reviewDeadline
Review deadline
Date
approvedBy
Email of user who approved the project
String
publishDate
Publish date
Date

Sample payload

{
title: 'Project title',
description: 'Project description',
labels: [ 'label1', 'label2', 'label3' ],
keyword: 'keyword',
status: 'content_map_draft',
suggestedBy: '[email protected]',
suggestedOn: '2022-07-19T16:43:35.033Z',
assignedBy: '[email protected]',
assignedTo: '[email protected]',
contributors: [ '[email protected]' ],
contentMapDeadline: '2022-07-27T03:30:00.000Z',
editorApprovers: [ '[email protected]' ],
editorDeadline: '2022-08-01T03:30:00.000Z',
approvers: [ '[email protected]' ],
reviewDeadline: '2022-08-04T03:30:00.000Z',
approvedBy: '[email protected]',
publishDate: '2022-08-05T03:30:00.000Z'
}
Previous
Finding and using your API key
Next
API Endpoints
Last modified 1mo ago
Copy link
On this page
Checking for the API Key
Post published, updated, or deleted
Subscriber added
Subscriber removed
Subscriber updated
Referral tier achieved
Project created or updated