webhooks

Create a webhook (PRO+)

Supported events: task.created, task.updated, task.deleted, task.status_changed, task.preview_ready, project.created, project.updated, project.deleted, project.billable_changed, project.schedule_pushed, project.readiness_checked, project.closeout_signed_off, project.archived, project.unarchived, deal.stage_changed, deal.quote_accepted, company.created, company.updated, comment.created, member.added, member.removed, migration.completed.

post/webhooks

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/webhooks
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Request body

urlstring uri required
eventsstring[] required
secretstring nullable

Used to compute HMAC-SHA256 signature on delivery

enabledboolean

Response

Webhook created

Changes

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