New: SerpPal for Chrome. Free grammar checks on every site, and the AI humanizer right where you write.

Get it free

Connect a custom API

Publish from SerpPal straight to your own site's blog API with a Bearer token. The requests SerpPal sends, the JSON fields, image uploads and how updates work.

If your site has its own blog API (a custom CMS, a Laravel or Node backend and so on), SerpPal can post to it directly. No Zapier and no extra code in between, as long as your API follows the simple layout below.

Use a webhook instead when you want SerpPal to send one signed message to a receiver that you write yourself.

What your API needs

SerpPal sends JSON with your token in an Authorization: Bearer <token> header. With an API address of https://api.example.com/api/v1/blogs it uses:

RequestWhat it does
POST /api/v1/blogsMakes a new post.
GET /api/v1/blogs/slug/{slug}Finds a post by its slug. Answer 404 when there is none.
PUT /api/v1/blogs/{id}Updates a post.
POST /api/v1/blogs/imagesUploads one image (multipart form, field image).

Only the first one is required. Without the slug lookup, a second publish makes a new post unless SerpPal already knows the post's id. Without the image upload, images stay linked from SerpPal's copy.

Connect it

  1. In SerpPal, open your project, click Project settings, and under Publishing click Connect a site.
  2. Choose Custom API and fill in:
FieldWhat to enter
API addressWhere new posts go, for example https://api.example.com/api/v1/blogs.
API tokenThe token your API accepts. SerpPal never shows it again after you save.
Website addressOptional. Your public site, for example https://example.com. Used to turn image paths into full links and to link to each post.
Post addressOptional. Where a post lives on your site. Default: /blog/{slug}. Use /{slug}/ if posts sit at the top level.
Article fieldOptional. The JSON field for the article HTML. Default: description.
Summary fieldOptional. The JSON field for the short summary. Default: short_overview.
  1. Click Connect. SerpPal calls the slug lookup with a made-up slug to check the address and the token. A "not found" answer is fine. The connection is named after your website.

The post SerpPal sends

json
{
  "title": "Best laptops for students",
  "slug": "best-student-laptops",
  "description": "<p>The article as HTML, with its images and videos in place.</p>",
  "short_overview": "A short guide to student laptops.",
  "meta_description": "A short guide to student laptops.",
  "status": "published",
  "publish_date": "2026-11-13",
  "read_time": 6,
  "tags": ["laptops", "students"],
  "categories": ["Guides"],
  "featured_image": "https://example.com/storage/blogs/cover.jpg",
  "featured_image_url": "https://example.com/storage/blogs/cover.jpg"
}
  • status is published or draft.
  • read_time is in minutes.
  • featured_image and featured_image_url are only sent when the post has a featured image.
  • description and short_overview change name if you set Article field or Summary field.

What your API should answer

Any 2xx status with JSON. SerpPal looks for the post's id in id, data.id, post.id or blog.id, and for its public address in url, data.url, link or data.link. If there is no address in the answer, SerpPal builds it from Website address and Post address.

For an image upload, answer with the image's link or path in data.public_url, public_url, data.url, url, data.path or path. A path such as /storage/blogs/pic.jpg is completed with your website address.

Publishing again

When you publish an article a second time, SerpPal updates the same post: it uses the id it saved, or finds the post by its slug, then sends PUT /{id}. If your API answers 404 because the post was removed, SerpPal makes it again. If it answers 405, SerpPal tries POST /{id}.

Troubleshooting

"Your API did not accept the token. Check it and try again.": your API answered 401 or 403. Check the token, and that your API reads the Authorization: Bearer header.

"Enter the API address and the API token": both fields are needed.

"That address is not reachable from the internet": the API address must be public. localhost and private network addresses are not accepted.

Images still point to serppal.com: the upload to /images failed or answered without a link, so SerpPal kept its own copy. Check the upload endpoint and what it answers.

A second publish made a duplicate: your API has no slug lookup at /slug/{slug}, or it answers without the post's id.

Updated November 20, 2026Still stuck? Contact support