Create a webhook endpoint

The event types and the signature are described on Follow-up.

Authentication

Send Authorization: Bearer gtk_…. Create the key under Connect assistant → API keys. A missing, invalid or revoked key is 401. A valid key while this API is not enabled for your organization answers 403 api_not_enabled, with what the key can do instead. Every response includes mySDR-Api-Version, mySDR-Request-Id and Cache-Control: no-store, and a response to an accepted key also X-RateLimit-* (so not a 401, a 405, an OPTIONS or a 404 for an unknown path).

Headers

• Idempotency-Key string · required — Required on this call. The same key and the same body replay the first response for 24 hours (Idempotent-Replayed: true). The same key with a different body is 409 idempotency_conflict.

Body parameters

• url string · required — HTTPS, port 443, a public host name, up to 2048 characters.
• events string[] — Types to send. Left out means all of them. One of: search.completed, search.failed.
• description string | null — Up to 200 characters.

Response

• id string · required — Endpoint id, whe_….
• object string · required — Always webhook_endpoint.
• url string · required — Where events are POSTed.
• events string[] · required — Subscribed types. ping is not in this list; the test always sends it.
• status string · required — enabled, disabled or deleted. Disabled after 3 events in a row that used every delivery attempt. One of: enabled, disabled, deleted.
• disabled_reason string | null — failing, or null.
• secret string · required — Signs every delivery. Shown only on create.

Credits

Free. Credits are charged when rows are stored, not when a delivery succeeds.

Errors

• 400 invalid_request — The URL is not public HTTPS on port 443.
• 409 idempotency_conflict — The Idempotency-Key was already used with another request body.
• 409 idempotency_in_progress — The first request with this Idempotency-Key is still being processed. Wait for the Retry-After header.
• 401 authentication_error — The Authorization header is missing, or the key is unknown or revoked.
• 403 permission_error — API access is not part of your plan, or your account is suspended.
• 403 api_not_enabled — The key is valid, but the Signals API or the Company API is not enabled for your organization yet. The error says what this key can do.
• 429 rate_limit_error — More than 60 requests per minute, or more than 3 at the same time, on one key. Wait for the Retry-After header.
• 500 internal_error — Something went wrong on our side.

Example

cURL

curl -X POST "https://mysdr.app/api/v1/webhook_endpoints" \
  -H "Authorization: Bearer $MYSDR_API_KEY" \
  -H "Idempotency-Key: idem-1" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/mysdr",
    "events": [
      "search.completed",
      "search.failed"
    ]
  }'

JavaScript

const response = await fetch('https://mysdr.app/api/v1/webhook_endpoints', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MYSDR_API_KEY}`,
    'Idempotency-Key': 'idem-1',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "url": "https://example.com/mysdr",
    "events": [
      "search.completed",
      "search.failed"
    ]
  })
});
const body = await response.json();

Python

import json
import os
import urllib.request

payload = {
  "url": "https://example.com/mysdr",
  "events": [
    "search.completed",
    "search.failed"
  ]
}

request = urllib.request.Request(
    "https://mysdr.app/api/v1/webhook_endpoints",
    headers={
    "Authorization": f"Bearer {os.environ['MYSDR_API_KEY']}",
    "Idempotency-Key": "idem-1",
    "Content-Type": "application/json"
    },
    data=json.dumps(payload).encode(),
    method="POST",
)
with urllib.request.urlopen(request) as response:
    body = json.load(response)

Example response

{
  "id": "whe_01J9Z6P8C8V0K3W6T2N8R5M1XH",
  "object": "webhook_endpoint",
  "url": "https://example.com/mysdr",
  "events": [
    "search.completed",
    "search.failed"
  ],
  "status": "enabled",
  "disabled_reason": null,
  "secret": "whsec_example"
}