Create a webhook

Registers a new webhook endpoint.


See also

Learn more about Webhooks

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
enum
Defaults to online
Allowed:
string
enum
Defaults to user
Allowed:
url
required
events
array of strings
required

Case.AssigneeUpdated, Case.ClientPortalWaitStepTriggered, Case.ContactHasActionsUpdated, Case.Created, Case.Deleted, Case.FlagsUpdated, Case.InfoUpdated, Case.MetadataUpdated, Case.ReviewConfirmed, Case.ReviewDue, Case.ReviewUpdated, Case.ReviewerHasActionsUpdated, Case.RiskUpdated, Case.StatusUpdated, Case.TagsUpdated, Case.TemplateUpdated, Case.Updated, CaseReport.Generated, Check.Approved, Check.Deleted, Check.Expired, Check.Rejected, Check.ReviewNeeded, Check.Started, Company.Created, Company.Deleted, Company.InfoUpdated, Company.MarkedAsNotRelevant, Company.MarkedAsRelevant, Company.Updated, DocumentOrder.Completed, DocumentOrder.Failed, Individual.Created, Individual.Deleted, Individual.InfoUpdated, Individual.MarkedAsNotRelevant, Individual.MarkedAsRelevant, Individual.Updated, Note.Created, Note.Deleted, Note.Updated, NoteComment.Created, NoteComment.Deleted, NoteComment.Updated

events*
string

A secret token used to sign the webhook payload. Autogenerated if not set.

Responses

400

The request is either malformed or contain invalid parameters.

  • Make sure the body payload matches the expected schema
  • Maximum items reached (default: 50). Contact us at [email protected] if you need more items.
Callbacks
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json