KnockEvents

Create Event: Knock

Create Event: Knock

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_idstringRequired
The Propexo unique identifier for the integration
prospect_idstringRequired
The Propexo unique identifier for the prospect
community_idstringRequired
The Propexo unique identifier for the community
event_nameenumRequired
The name or type of event
Allowed values:
attribution_idstringOptional
The Propexo unique identifier for the attribution. Required for CALL events
agent_idstringOptional
The Propexo unique identifier for the agent. Required for SMS, CHAT, CALL, and EMAIL events
event_datetimestringOptionalformat: "date-time"
The date when the event will occur. Required for SMS, CHAT, ACTIVITY, and EMAIL events
notesstringOptional
Notes associated with the event. Required for SMS, CHAT, and ACTIVITY events
email_bodystringOptional
The body of the email. Required for EMAIL events
email_subjectstringOptional
The subject of the email. Required for EMAIL events
call_statusenumOptional
The status of the call. Required for CALL events
time_fromstringOptionalformat: "date-time"
The start time of the event. Required for CALL events
time_tostringOptionalformat: "date-time"
The end time of the event. Required for CALL events

Response

Successful response
metaobject
resultobject

Errors