webhooks

Create Webhook

Create a webhook subscription. The signing secret is returned once.

kind=filter sends domain.matched_filter when a report starts matching the same filters as POST /v1/reports/search. kind=reports watches specific reports for auction changes and for this account's note, tag, and favorite changes. kind=user sends usertask.created and usertask.completed and does not take a report list. Zapier, Make, n8n, and IFTTT use the HTTPS URL from their webhook trigger.

post/v1/webhooks/

Request

  • Base URL: https://api.karma.domains
  • URL: https://api.karma.domains/v1/webhooks/
  • Auth: HTTP bearer

Request body

kindstring required
urlstring required
eventsstring[] required
filterobject nullable
basesstring[] nullable
max_events_per_runinteger nullable
ending_soon_secondsinteger nullable

Response

Successful Response

idstring required
kindstring required
urlstring required
statusstring required
eventsstring[] required
filterobject nullable
basesstring[] nullable
max_events_per_runinteger nullable
ending_soon_secondsinteger nullable
reportsobject[] nullable
created_atinteger nullable
updated_atinteger nullable
disabled_reasonstring nullable
cursor_changed_atinteger nullable
secretstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.