DOdotfile
Webhooks

Create a webhook

Changed on

Registers a new webhook endpoint.

See also

Learn more about Webhooks

post/v1/webhooks

Request

  • Base URL
    https://api.dotfile.com
  • Auth
    API key in header X-DOTFILE-API-KEY

Request body

namestring
status'online' | 'offline'
type'user' | 'system'
urlstring url required
eventsstring[] required

AutonomyChatRun.Completed, AutonomyChatRun.Failed, Case.ApprovalAdded, Case.ApprovalWithdrawn, Case.AssigneeUpdated, Case.ClientPortalWaitStepTriggered, Case.ContactHasActionsUpdated, Case.Created, Case.Deleted, Case.FlagsUpdated, Case.InfoUpdated, Case.MetadataUpdated, Case.RequiredReviewersUpdated, 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.ProcessingStarted, 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

secretstring

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

Response

The created webhook

ℹ️ Click to see full payload

idstring uuid required
namestring required
status'online' | 'offline' required
type'user' | 'system' required

system webhooks are hidden from console app.

eventsstring[] required
urlstring url required
secretstring required

A secret token used to sign the webhook payload.

created_atstring date-time required

Creation date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

updated_atstring date-time required

Latest update date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

Changes

  • 50cab516e856Revision changes
    • info

      added the new AutonomyChatRun.Completed enum value to the request property /

    • info

      added the new AutonomyChatRun.Failed enum value to the request property /

    • info

      added the new Case.ApprovalAdded enum value to the request property /

    • info

      added the new Case.ApprovalWithdrawn enum value to the request property /

    • info

      added the new Case.RequiredReviewersUpdated enum value to the request property /

    • info

      added the new Check.ProcessingStarted enum value to the request property /