Send Content with Webhooks

Add an HTTPS webhook URL under Developer and select Connect webhook, then use Test ping to confirm it works. Your endpoint must return a 2xx response within a few seconds. Requires Creator or above.

Last updated 1 day ago

Webhooks let NarraSEO notify your system when something happens, so you do not have to poll the API asking whether anything has changed.

Listed as Webhook under Developer.

Plan Requirement

Creator or above. Below that you see "Outbound webhooks require Creator or above. Compare plans to upgrade."

Creator includes 5,000 webhook deliveries a month.

What your Endpoint Needs to Do

The requirements are stated on the field itself: "Must start with https://. Private or local addresses are blocked. Return a 2xx within a few seconds."

Three things follow from that:

HTTPS only. Plain HTTP is rejected.

Publicly reachable. localhost, 127.0.0.1, and private network addresses are blocked. For local development, use a tunnelling service that gives you a public HTTPS URL.

Respond fast, work later. Return a 2xx immediately and do the actual processing in the background. An endpoint that runs a site rebuild before responding will time out.

Steps

  1. Open Sidebar β†’ Integrations.
  2. Find Webhook under Developer.
  3. Enter your Webhook URL, for example https://example.com/hooks/narraseo.
  4. Select Connect webhook.
  5. Select Test ping.

Testing

Webhooks use Test ping rather than Verify connection. It shows Sending… while it works.

On success: "Test ping delivered."

On failure: "Test ping failed. Check the URL and try again."

Run the test before relying on it. A webhook that silently fails is worse than no webhook, because you will assume your content is flowing.

If the Test Ping Fails

Your endpoint returned a non-2xx status. Check your logs. A 401 usually means your own authentication is rejecting the request, and a 404 means the route is wrong.

It took too long. Return the 2xx first and process afterwards.

The URL is private or local. Use a public HTTPS address.

A firewall is blocking it. Confirm the endpoint is reachable from outside your network.

HTTP instead of HTTPS. Only HTTPS is accepted.

Common Uses

Revalidating a static site. The main reason to use webhooks with the Next.js Blog package: publish an article, and your pages revalidate without waiting for a scheduled rebuild.

Triggering downstream work. Notifying a Slack channel, adding a row to a sheet, or kicking off a social post.

Keeping a mirror in sync. Pulling the article through the API when the webhook tells you it exists.

Notes

Deliveries count against your monthly allowance. Creator includes 5,000.

Webhooks and the API complement each other. The webhook tells you something happened, and the API gives you the content.

Build your endpoint to tolerate a delivery arriving more than once. Handling the same event twice without side effects is the usual way to stay safe with any webhook system.

The connection is per project.

Using the NarraSEO API covers pulling content. Publishing to a Next.js blog uses both together.