AT AppointmentTrader
Sign In
Online Now  

/v1/event/

Signed developer webhooks, subscriptions and 90-day delivery history. Restricted developer access is required.
GET

/v1/event/get_available_events

#
Returns the webhook catalog, payload fields and examples available to this account.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/event/get_available_events' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_get_available_events_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadarray Yes
$.oneOf[0].allOf[1].Payload[]WebhookCatalogEntry No
$.oneOf[0].allOf[1].Payload[].oneOf[0]object No
$.oneOf[0].allOf[1].Payload[].oneOf[0].alias = "bid.created" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].audience = "account" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].fields.bid_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].fields.status = "status" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].example.type = "bid.created" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].example.data.bid_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[0].example.data.statusstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1]object No
$.oneOf[0].allOf[1].Payload[].oneOf[1].alias = "bid.status_changed" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].audience = "account" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].fields.bid_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].fields.status = "status" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].fields.previous_status = "status" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].example.type = "bid.status_changed" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].example.data.bid_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].example.data.statusstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[1].example.data.previous_statusstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2]object No
$.oneOf[0].allOf[1].Payload[].oneOf[2].alias = "listing.created" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].audience = "account" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].fields.listing_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].fields.status = "status" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].example.type = "listing.created" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].example.data.listing_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[2].example.data.statusstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3]object No
$.oneOf[0].allOf[1].Payload[].oneOf[3].alias = "listing.status_changed" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].audience = "account" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].fields.listing_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].fields.status = "status" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].fields.previous_status = "status" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].example.type = "listing.status_changed" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].example.data.listing_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].example.data.statusstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[3].example.data.previous_statusstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4]object No
$.oneOf[0].allOf[1].Payload[].oneOf[4].alias = "transaction.created" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].audience = "account" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].fields.transaction_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].fields.status = "status" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].example.type = "transaction.created" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].example.data.transaction_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[4].example.data.statusstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5]object No
$.oneOf[0].allOf[1].Payload[].oneOf[5].alias = "transaction.status_changed" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].audience = "account" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].fields.transaction_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].fields.status = "status" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].fields.previous_status = "status" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].example.type = "transaction.status_changed" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].example.data.transaction_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].example.data.statusstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[5].example.data.previous_statusstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6]object No
$.oneOf[0].allOf[1].Payload[].oneOf[6].alias = "marketplace.bid.published" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].audience = "public" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].fields.bid_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].example.type = "marketplace.bid.published" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[6].example.data.bid_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7]object No
$.oneOf[0].allOf[1].Payload[].oneOf[7].alias = "marketplace.bid.withdrawn" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].audience = "public" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].fields.bid_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].example.type = "marketplace.bid.withdrawn" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[7].example.data.bid_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8]object No
$.oneOf[0].allOf[1].Payload[].oneOf[8].alias = "marketplace.listing.published" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].audience = "public" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].fields.listing_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].example.type = "marketplace.listing.published" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[8].example.data.listing_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9]object No
$.oneOf[0].allOf[1].Payload[].oneOf[9].alias = "marketplace.listing.withdrawn" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].audience = "public" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].fields.listing_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].example.type = "marketplace.listing.withdrawn" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[9].example.data.listing_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10]object No
$.oneOf[0].allOf[1].Payload[].oneOf[10].alias = "community.post.published" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].audience = "public" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].fields.post_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].example.type = "community.post.published" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[10].example.data.post_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11]object No
$.oneOf[0].allOf[1].Payload[].oneOf[11].alias = "message.received" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].descriptionstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].audience = "account" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].fieldsobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].fields.chat_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].fields.message_id = "id" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].exampleobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].example.idstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].example.type = "message.received" Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].example.schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].example.occurred_atstring Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].example.environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].example.dataobject Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].example.data.chat_idinteger Yes
$.oneOf[0].allOf[1].Payload[].oneOf[11].example.data.message_idinteger Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/get_available_events",
    "RequestUserAlias": "example-user",
    "Payload": []
}
Machine-readable endpoint documentation
GET

/v1/event/get_delivery

#
Returns one delivery payload and its most recent 100 attempts. Revoked resource access hides payload and response excerpts.

Parameters

NameTypeRequiredDefaultDescription
deliveryID int Yes — Delivery ID from the history.
beforeAttempt int No 0 Exclusive attempt cursor; use next_attempt_before for the previous 100 attempts.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/event/get_delivery' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'deliveryID={{deliveryID}}' \
  --data-urlencode 'beforeAttempt={{beforeAttempt}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_get_delivery_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.idinteger Yes
$.oneOf[0].allOf[1].Payload.statusstring ["pending","retry","sending","delivered","failed","cancelled"] Yes
$.oneOf[0].allOf[1].Payload.event_idstring Yes
$.oneOf[0].allOf[1].Payload.payload Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0]WebhookEvent Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].type = "bid.created" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].data.bid_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].data.statusstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].type = "bid.status_changed" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].data.bid_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].data.statusstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].data.previous_statusstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].type = "listing.created" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].data.listing_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].data.statusstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].type = "listing.status_changed" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].data.listing_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].data.statusstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].data.previous_statusstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].type = "transaction.created" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].data.transaction_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].data.statusstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].type = "transaction.status_changed" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].data.transaction_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].data.statusstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].data.previous_statusstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].type = "marketplace.bid.published" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].data.bid_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].type = "marketplace.bid.withdrawn" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].data.bid_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].type = "marketplace.listing.published" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].data.listing_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].type = "marketplace.listing.withdrawn" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].data.listing_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].type = "community.post.published" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].data.post_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].type = "message.received" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].data.chat_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].data.message_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12]object Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].idstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].type = "webhook.test" Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].schema_version = 1 Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].occurred_atstring Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].environmentstring ["rc","preview","production"] Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].dataobject Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].data.endpoint_idinteger Yes
$.oneOf[0].allOf[1].Payload.payload.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.attemptsarray Yes
$.oneOf[0].allOf[1].Payload.attempts[]object No
$.oneOf[0].allOf[1].Payload.attempts[].AttemptNumberDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.attempts[].AttemptNumber.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.attempts[].AttemptNumber.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.attempts[].CreatedDatestring Yes
$.oneOf[0].allOf[1].Payload.attempts[].CompletedDate Yes
$.oneOf[0].allOf[1].Payload.attempts[].CompletedDate.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.attempts[].CompletedDate.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.attempts[].HTTPStatus Yes
$.oneOf[0].allOf[1].Payload.attempts[].HTTPStatus.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.attempts[].HTTPStatus.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.attempts[].HTTPStatus.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.attempts[].HTTPStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.attempts[].DurationMilliseconds Yes
$.oneOf[0].allOf[1].Payload.attempts[].DurationMilliseconds.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.attempts[].DurationMilliseconds.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.attempts[].DurationMilliseconds.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.attempts[].DurationMilliseconds.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.attempts[].Error Yes
$.oneOf[0].allOf[1].Payload.attempts[].Error.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.attempts[].Error.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.attempts[].ResponseExcerpt Yes
$.oneOf[0].allOf[1].Payload.attempts[].ResponseExcerpt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.attempts[].ResponseExcerpt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.next_attempt_before YesExclusive cursor for the next page of older attempts; null when exhausted.
$.oneOf[0].allOf[1].Payload.next_attempt_before.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.next_attempt_before.anyOf[1]null Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/get_delivery",
    "RequestUserAlias": "example-user",
    "Payload": {
        "id": 0,
        "status": "pending",
        "event_id": "synthetic-example",
        "payload": {
            "id": "synthetic-example",
            "type": "bid.created",
            "schema_version": 1,
            "occurred_at": "synthetic-example",
            "environment": "rc",
            "data": {
                "bid_id": 1,
                "status": "synthetic-example"
            }
        },
        "attempts": [],
        "next_attempt_before": 0
    }
}
Machine-readable endpoint documentation
GET

/v1/event/get_delivery_history

#
Returns up to 50 deliveries, newest first. Pass the last ID as beforeID for the next page.

Parameters

NameTypeRequiredDefaultDescription
endpointID int No 0 Optional endpoint filter.
eventAlias string No "" Optional catalog event alias.
status string No "" Optional pending, retry, sending, delivered, failed or cancelled filter.
beforeID int No 0 Exclusive delivery cursor.
fromDate string No "" Inclusive server date, YYYY-MM-DD.
toDate string No "" Inclusive server date, YYYY-MM-DD.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/event/get_delivery_history' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'endpointID={{endpointID}}' \
  --data-urlencode 'eventAlias={{eventAlias}}' \
  --data-urlencode 'status={{status}}' \
  --data-urlencode 'beforeID={{beforeID}}' \
  --data-urlencode 'fromDate={{fromDate}}' \
  --data-urlencode 'toDate={{toDate}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_get_delivery_history_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadarray Yes
$.oneOf[0].allOf[1].Payload[]object No
$.oneOf[0].allOf[1].Payload[].IDDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ID.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].ID.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].EndpointIDDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].EndpointID.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].EndpointID.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].Namestring Yes
$.oneOf[0].allOf[1].Payload[].EventIDstring Yes
$.oneOf[0].allOf[1].Payload[].EventAliasstring Yes
$.oneOf[0].allOf[1].Payload[].CreatedDatestring Yes
$.oneOf[0].allOf[1].Payload[].Statusstring ["pending","retry","sending","delivered","failed","cancelled"] Yes
$.oneOf[0].allOf[1].Payload[].AttemptCountDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].AttemptCount.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].AttemptCount.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].LastHTTPStatus Yes
$.oneOf[0].allOf[1].Payload[].LastHTTPStatus.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].LastHTTPStatus.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].LastHTTPStatus.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].LastHTTPStatus.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload[].LastError Yes
$.oneOf[0].allOf[1].Payload[].LastError.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload[].LastError.anyOf[1]null Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/get_delivery_history",
    "RequestUserAlias": "example-user",
    "Payload": []
}
Machine-readable endpoint documentation
GET

/v1/event/get_status

#
Returns webhook queue health for your endpoints.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/event/get_status' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_get_status_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadarray Yes
$.oneOf[0].allOf[1].Payload[]object No
$.oneOf[0].allOf[1].Payload[].Statusstring ["pending","retry","sending","delivered","failed","cancelled"] Yes
$.oneOf[0].allOf[1].Payload[].CountDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].Count.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].Count.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].OldestDatestring Yes
$.oneOf[0].allOf[1].Payload[].OldestAgeSecondsinteger Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/get_status",
    "RequestUserAlias": "example-user",
    "Payload": []
}
Machine-readable endpoint documentation
GET

/v1/event/get_subscriptions

#
Returns your endpoints and their selected event topics. Signing secrets are never included.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/event/get_subscriptions' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_get_subscriptions_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadarray Yes
$.oneOf[0].allOf[1].Payload[]object No
$.oneOf[0].allOf[1].Payload[].IDDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ID.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].ID.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].CreatedDatestring Yes
$.oneOf[0].allOf[1].Payload[].Namestring Yes
$.oneOf[0].allOf[1].Payload[].URLstring Yes
$.oneOf[0].allOf[1].Payload[].EnabledDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].Enabled.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].Enabled.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].RevisionDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].Revision.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].Revision.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].Eventsarray Yes
$.oneOf[0].allOf[1].Payload[].Events[]string No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/get_subscriptions",
    "RequestUserAlias": "example-user",
    "Payload": []
}
Machine-readable endpoint documentation
POST

/v1/event/set_delete_endpoint

#
Deletes an endpoint, cancels pending work and destroys its signing secrets. History remains for 90 days.

Parameters

NameTypeRequiredDefaultDescription
endpointID int Yes — Your endpoint ID.
isWritingRequest bool No false Set true to perform this write.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/event/set_delete_endpoint' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'endpointID={{endpointID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_set_delete_endpoint_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.endpoint_idinteger Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_delete_endpoint",
    "RequestUserAlias": "example-user",
    "Payload": {
        "endpoint_id": 0
    }
}
Machine-readable endpoint documentation
POST

/v1/event/set_endpoint

#
Creates or updates an HTTPS endpoint. URL changes cancel pending deliveries to the old URL. Select topics explicitly; there is no backfill.

Parameters

NameTypeRequiredDefaultDescription
name string Yes — Display name.
url string Yes — Public HTTPS destination on port 443.
eventAliasesJSON string Yes — JSON array of event aliases.
endpointID int No 0 Zero creates a new endpoint.
enabled bool No true Whether to receive events.
isWritingRequest bool No false Set true to perform this write.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/event/set_endpoint' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'url={{url}}' \
  --data-urlencode 'eventAliasesJSON={{eventAliasesJSON}}' \
  --data-urlencode 'endpointID={{endpointID}}' \
  --data-urlencode 'enabled={{enabled}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Parameters: eventAliasesJSON
FieldTypeRequiredDescription
eventAliasesJSONstring (application/json) Yes
eventAliasesJSONarray (decoded JSON) Yes
eventAliasesJSON[]string ["bid.created","bid.status_changed","listing.created","listing.status_changed","transaction.created","transaction.status_changed","marketplace.bid.published","marketplace.bid.withdrawn","marketplace.listing.published","marketplace.listing.withdrawn","community.post.published","message.received"] No
Response fields
FieldTypeRequiredDescription
$event_set_endpoint_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.endpoint_idinteger Yes
$.oneOf[0].allOf[1].Payload.signing_secretstring NoReturned only at creation; store securely. Example values are fake.
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_endpoint",
    "RequestUserAlias": "example-user",
    "Payload": {
        "endpoint_id": 0
    }
}
Machine-readable endpoint documentation
POST

/v1/event/set_resend

#
Resends an existing delivery to the current endpoint URL after current authorization checks. Event ID and payload remain unchanged; recipients must deduplicate.

Parameters

NameTypeRequiredDefaultDescription
deliveryID int Yes — Delivery ID from your history.
isWritingRequest bool No false Set true to perform this write.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/event/set_resend' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'deliveryID={{deliveryID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_set_resend_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.delivery_idinteger Yes
$.oneOf[0].allOf[1].Payload.queued = true Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_resend",
    "RequestUserAlias": "example-user",
    "Payload": {
        "delivery_id": 0,
        "queued": true
    }
}
Machine-readable endpoint documentation
POST

/v1/event/set_rotate_secret

#
Rotates an endpoint signing secret. Both keys sign for 24 hours unless immediate revocation is requested.

Parameters

NameTypeRequiredDefaultDescription
endpointID int Yes — Your endpoint ID.
revokeImmediately bool No false Immediately revoke the previous key instead of overlapping.
isWritingRequest bool No false Set true to perform this write.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/event/set_rotate_secret' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'endpointID={{endpointID}}' \
  --data-urlencode 'revokeImmediately={{revokeImmediately}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_set_rotate_secret_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.endpoint_idinteger Yes
$.oneOf[0].allOf[1].Payload.signing_secretstring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_rotate_secret",
    "RequestUserAlias": "example-user",
    "Payload": {
        "endpoint_id": 101,
        "signing_secret": "SYNTHETIC_SIGNING_SECRET"
    }
}
Machine-readable endpoint documentation
POST

/v1/event/set_subscribe

#
Subscribes an HTTPS URL to one event. Deliveries use signed JSON POST, not GET parameters.

Parameters

NameTypeRequiredDefaultDescription
webhookAlias string Yes — Catalog alias.
url string Yes — Public HTTPS destination.
isWritingRequest bool No false Set true to perform this write.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/event/set_subscribe' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'webhookAlias={{webhookAlias}}' \
  --data-urlencode 'url={{url}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_set_subscribe_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.endpoint_idinteger Yes
$.oneOf[0].allOf[1].Payload.signing_secretstring NoReturned only at creation; store securely. Example values are fake.
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_subscribe",
    "RequestUserAlias": "example-user",
    "Payload": {
        "endpoint_id": 0
    }
}
Machine-readable endpoint documentation
POST

/v1/event/set_test

#
Queues a signed webhook.test for your enabled endpoint; no business mutation occurs.

Parameters

NameTypeRequiredDefaultDescription
endpointID int Yes — Your endpoint ID.
isWritingRequest bool No false Set true to perform this write.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/event/set_test' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'endpointID={{endpointID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_set_test_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.event_idstring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_test",
    "RequestUserAlias": "example-user",
    "Payload": {
        "event_id": "synthetic-example"
    }
}
Machine-readable endpoint documentation
POST

/v1/event/set_unsubscribe

#
Removes a topic from an endpoint. Remaining deliveries for that topic are suppressed before sending.

Parameters

NameTypeRequiredDefaultDescription
endpointID int Yes — Your endpoint ID.
webhookAlias string Yes — Event alias to remove.
isWritingRequest bool No false Set true to perform this write.
Request example (cURL) 
curl --request POST \
  'https://ca.appointmenttrader.com/v1/event/set_unsubscribe' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'endpointID={{endpointID}}' \
  --data-urlencode 'webhookAlias={{webhookAlias}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$event_set_unsubscribe_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.endpoint_idinteger Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_unsubscribe",
    "RequestUserAlias": "example-user",
    "Payload": {
        "endpoint_id": 0
    }
}
Machine-readable endpoint documentation