Custom API integration

Approved work lands in Custom API, without copy-paste.

We deliver finished content to your endpoint as signed JSON under a documented webhook contract.

How it works

If your stack is not on our connector list, or you would rather own the last mile, the custom API integration sends each approved piece to an endpoint you define. The payload is signed JSON under a documented webhook contract: the content itself, metadata, image references, and the intended state, in a versioned schema your developers build against once.

Delivery is treated as seriously as content. Failed deliveries retry with exponential backoff, every attempt lands in a delivery log you can inspect, and a test-delivery button sends a sample payload on demand so you can verify your handler before and after deploys. Signatures let your endpoint confirm each payload actually came from us before trusting it.

Best forTeams with a custom stack or bespoke workflow who want finished content pushed to them instead of pulled from anywhere.

Setup, step by step

  1. Stand up an HTTPS endpoint that accepts POSTed JSON, in whatever framework your stack uses.
  2. Register the endpoint URL in SearchHandled and note the signing secret we generate for it.
  3. Implement signature verification in your handler using that secret, following the contract docs.
  4. Use the test-delivery button to send a sample payload and confirm your handler parses and verifies it.
  5. Decide how your side maps the payload's state field into your own draft and publish workflow.

What lands in Custom API

ElementHow it lands
Title and bodyConverted to the native format, then verified by reading the entry back.
SEO metadataMapped to the platform's own fields, and flagged where it has none.
ImagesUploaded to your media storage with alt text. Never hotlinked.
Internal linksRewritten to your live URLs and checked against redirects.
Publish stateWhatever your workflow defines.

Field mapping is confirmed against your own content model during setup. Connectors are on every plan; the number of connected sites is what varies.

Best practices

Verify signatures before trusting payloads

Every delivery is signed with your endpoint's secret. Verifying the signature in your handler is the difference between accepting our content and accepting anyone's POST, so make it the first thing the handler does.

Return status codes honestly

Our retry logic keys off your response. Return success only after you have durably accepted the payload, and return an error when you have not, so retries happen exactly when they should.

Build against the schema version

Payloads carry a version, and we do not change a version's shape after publishing it. Pin your handler to the version you built against and treat a version bump as a deliberate upgrade.

Retest after deploys

The most common breakage is a customer deploy that changes the endpoint's behavior. The test-delivery button exists for exactly that moment, so make it part of your deploy checklist.

Known issues

What practitioners actually report, from official docs, issue trackers, and community forums.

Endpoint downtime

Your endpoint is unreachable or erroring when a delivery fires, and without retries the content would silently never arrive.

How we handle itFailed deliveries retry with exponential backoff, and every attempt is recorded in a delivery log you can inspect, so a brief outage delays content instead of losing it.

searchhandled.com

Contract drift after customer deploys

A deploy on your side changes what the endpoint accepts, and deliveries that worked yesterday start failing in ways that look like our problem.

How we handle itThe payload schema is versioned so our side never changes shape unannounced, and the test-delivery button lets you confirm your handler after any deploy in seconds.

searchhandled.com

Questions teams ask

What does the payload contain?

The finished content, its metadata such as title, slug, description, and tags, image references, and the intended state like draft or publish, all as JSON under a versioned schema documented in the contract docs.

How do retries work?

If your endpoint returns an error or is unreachable, we retry with exponential backoff and log every attempt. You can watch the delivery log in your dashboard and trigger a manual redelivery once your endpoint is healthy.

How do we verify a payload really came from SearchHandled?

Each delivery is signed with the secret generated for your endpoint. Your handler recomputes the signature over the payload and compares it, as shown in the contract docs, and rejects anything that does not match.

Connect Custom API

One tested path from approval to publish.

Bring your content model to setup. We will map the destination and validate a draft before anything goes live.

Build my Growth Map