Sign in
webhook-events

Changed on

ViewSet for webhook events. Provides read-only operations (list, retrieve) and a custom retry action.

get/webhook-events/{id}{format}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

format'.json' required
idstring required

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Response

configurationinteger required
main_eventinteger required
event_type'calendar_event_created' | 'calendar_event_updated' | 'calendar_event_deleted' | 'calendar_event_attendee_added' | 'calendar_event_attendee_removed' | 'calendar_event_attendee_updated' | 'organization_member_created' required
  • calendar_event_created - Calendar Event Created
  • calendar_event_updated - Calendar Event Updated
  • calendar_event_deleted - Calendar Event Deleted
  • calendar_event_attendee_added - Calendar Event Attendee Added
  • calendar_event_attendee_removed - Calendar Event Attendee Removed
  • calendar_event_attendee_updated - Calendar Event Attendee Updated
  • organization_member_created - Organization member created
urlstring uri required
status'pending' | 'success' | 'failed' required
  • pending - Pending
  • success - Success
  • failed - Failed
headersunknown
payloadunknown required
response_statusinteger nullable required
response_bodyunknown required
response_headersunknown required
retry_numberinteger nullable required
send_afterstring date-time nullable required
createdstring date-time required
modifiedstring date-time required

Changes