Send a test webhook delivery

POST

webhooks

{webhook_id}

test

Send a test delivery

curl --request POST \
  --url https://api.orbitsearch.com/v3/webhooks/{webhook_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "profile.updated"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({event_type: 'profile.updated'})
};

fetch('https://api.orbitsearch.com/v3/webhooks/{webhook_id}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orbitsearch.com/v3/webhooks/{webhook_id}/test"

payload = { "event_type": "profile.updated" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "webhook_id": "6f2f1f37-8f9f-4a51-9a2f-2f1cbb1a9d20",
  "url": "https://example.com/***hook",
  "event_id": "evt_test_9c1f2a5b7d3e4f6a8b0c1d2e",
  "event_type": "profile.updated",
  "payload_source": "example",
  "delivered": true,
  "response_status": 200,
  "duration_ms": 143,
  "error": null
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Use this while you are building your handler: it signs and posts a real delivery to your registered endpoint immediately, so you can check your signature verification, your parsing, and your response — without waiting for a watcher run.

What gets sent

The delivery is identical to a live one — same headers, same signature scheme, and the same envelope with the event payload in data — with two differences that let you tell it apart:

The envelope carries "test": true.
The event ID starts with evt_test_.

{
  "id": "evt_test_9c1f2a5b7d3e4f6a8b0c1d2e",
  "type": "profile.updated",
  "created": "1788451200",
  "test": true,
  "data": { "orbitId": "11111111-1111-4111-8111-111111111111", "newEventCount": 1, "events": [] }
}

data is your most recent event of this type from the last 30 days when you have one, and the documented example payload for a dummy profile otherwise — payload_source in the response says which. Either way the field names, shapes and caps match a live delivery, so a handler written against a test delivery works unchanged against the real one. Verify the signature exactly as you would for a live delivery: see Events & signatures. Omit event_type to test the first event type the endpoint subscribes to. Slack incoming-webhook endpoints receive the same formatted Slack message a live delivery would.

Reading the result

A 200 means Orbit attempted the delivery and is reporting the outcome — including a failure on your side:

{
  "delivered": false,
  "response_status": 500,
  "duration_ms": 88,
  "error": "http_500"
}

delivered is true only when your server answered 2xx. When it never answered, response_status is null and error carries the reason, for example ECONNREFUSED or timeout of 10000ms exceeded.

Test deliveries are free, are attempted exactly once with no retries, and are not recorded in your delivery history. A failed test never counts toward the 20 consecutive failures that disable an endpoint, so you can iterate on your handler safely.

Because each call makes an outbound request, this route is rate limited more tightly than the rest of the API: 0.5 requests/second with a burst of 10.

Authorizations

Authorization

string

header

required

Use an Orbit API key from the developer dashboard.

Path Parameters

webhook_id

string<uuid>

required

The webhook endpoint ID returned at creation.

Body

application/json

Optional. Defaults to the first event type the endpoint subscribes to; must be one of its subscribed types.

event_type

enum<string>

Available options:

profile.updated,

company.thesis.changed,

company.alert,

portfolio.changed

Response

The delivery was attempted. A non-2xx response from your server is reported here, not as an API error.

webhook_id

string<uuid>

required

event_id

string

required

The delivery ID sent in x-orbit-webhook-event-id. Test deliveries always start with evt_test_.

event_type

enum<string>

required

Available options:

profile.updated,

company.thesis.changed,

company.alert,

portfolio.changed

payload_source

enum<string>

required

recent_event when the body replayed your most recent event of this type from the last 30 days, example when it carried the documented example payload.

Available options:

recent_event,

example

delivered

boolean

required

True when your server answered 2xx.

duration_ms

integer

required

How long the attempt took, in milliseconds.

url

string

The endpoint URL the test was delivered to, redacted the same way list responses redact it.

response_status

integer | null

The HTTP status your server returned, or null when the request never completed.

error

string | null

Why the delivery failed, for example http_500 or ECONNREFUSED. Null on success.

Send a test delivery

curl --request POST \
  --url https://api.orbitsearch.com/v3/webhooks/{webhook_id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "profile.updated"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({event_type: 'profile.updated'})
};

fetch('https://api.orbitsearch.com/v3/webhooks/{webhook_id}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orbitsearch.com/v3/webhooks/{webhook_id}/test"

payload = { "event_type": "profile.updated" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "webhook_id": "6f2f1f37-8f9f-4a51-9a2f-2f1cbb1a9d20",
  "url": "https://example.com/***hook",
  "event_id": "evt_test_9c1f2a5b7d3e4f6a8b0c1d2e",
  "event_type": "profile.updated",
  "payload_source": "example",
  "delivered": true,
  "response_status": 200,
  "duration_ms": 143,
  "error": null
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Search

Enrich

Watchers

Webhooks

Keys

Send a test webhook delivery

What gets sent

Reading the result

Authorizations

Path Parameters

Body

Response

​What gets sent

​Reading the result

Authorizations

Path Parameters

Body

Response

What gets sent

Reading the result