Справочник API event

GET

/v1/event/get_available_events

#

Returns the webhook catalog, payload fields and examples available to this account.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/event/get_available_events' \
  --data-urlencode 'key={{API_KEY}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`event_get_available_events_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload[]`	`WebhookCatalogEntry`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[0]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].alias`	`= "bid.created"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].audience`	`= "account"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].fields.bid_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].fields.status`	`= "status"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].example.type`	`= "bid.created"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].example.data.bid_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[0].example.data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].alias`	`= "bid.status_changed"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].audience`	`= "account"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].fields.bid_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].fields.status`	`= "status"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].fields.previous_status`	`= "status"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].example.type`	`= "bid.status_changed"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].example.data.bid_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].example.data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[1].example.data.previous_status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].alias`	`= "listing.created"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].audience`	`= "account"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].fields.listing_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].fields.status`	`= "status"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].example.type`	`= "listing.created"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].example.data.listing_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[2].example.data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].alias`	`= "listing.status_changed"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].audience`	`= "account"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].fields.listing_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].fields.status`	`= "status"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].fields.previous_status`	`= "status"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].example.type`	`= "listing.status_changed"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].example.data.listing_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].example.data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[3].example.data.previous_status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].alias`	`= "transaction.created"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].audience`	`= "account"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].fields.transaction_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].fields.status`	`= "status"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].example.type`	`= "transaction.created"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].example.data.transaction_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[4].example.data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].alias`	`= "transaction.status_changed"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].audience`	`= "account"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].fields.transaction_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].fields.status`	`= "status"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].fields.previous_status`	`= "status"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].example.type`	`= "transaction.status_changed"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].example.data.transaction_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].example.data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[5].example.data.previous_status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].alias`	`= "marketplace.bid.published"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].audience`	`= "public"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].fields.bid_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].example.type`	`= "marketplace.bid.published"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[6].example.data.bid_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].alias`	`= "marketplace.bid.withdrawn"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].audience`	`= "public"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].fields.bid_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].example.type`	`= "marketplace.bid.withdrawn"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[7].example.data.bid_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].alias`	`= "marketplace.listing.published"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].audience`	`= "public"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].fields.listing_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].example.type`	`= "marketplace.listing.published"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[8].example.data.listing_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].alias`	`= "marketplace.listing.withdrawn"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].audience`	`= "public"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].fields.listing_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].example.type`	`= "marketplace.listing.withdrawn"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[9].example.data.listing_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].alias`	`= "community.post.published"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].audience`	`= "public"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].fields.post_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].example.type`	`= "community.post.published"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[10].example.data.post_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].alias`	`= "message.received"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].audience`	`= "account"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].fields`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].fields.chat_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].fields.message_id`	`= "id"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].example`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].example.id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].example.type`	`= "message.received"`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].example.schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].example.occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].example.environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].example.data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].example.data.chat_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].oneOf[11].example.data.message_id`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/get_available_events",
    "RequestUserAlias": "example-user",
    "Payload": []
}

Машиночитаемая документация метода

GET

/v1/event/get_delivery

#

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

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`deliveryID`	`int`	`Да`	`—`	Delivery ID from the history.
`beforeAttempt`	`int`	`Нет`	`0`	Exclusive attempt cursor; use next_attempt_before for the previous 100 attempts.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/event/get_delivery' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'deliveryID={{deliveryID}}' \
  --data-urlencode 'beforeAttempt={{beforeAttempt}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`event_get_delivery_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.status`	`string ["pending","retry","sending","delivered","failed","cancelled"]`	`Да`
`$.oneOf[0].allOf[1].Payload.event_id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload`		`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0]`	`WebhookEvent`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].type`	`= "bid.created"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].data.bid_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[0].data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].type`	`= "bid.status_changed"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].data.bid_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[1].data.previous_status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].type`	`= "listing.created"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].data.listing_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[2].data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].type`	`= "listing.status_changed"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].data.listing_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[3].data.previous_status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].type`	`= "transaction.created"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].data.transaction_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[4].data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].type`	`= "transaction.status_changed"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].data.transaction_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].data.status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[5].data.previous_status`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].type`	`= "marketplace.bid.published"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[6].data.bid_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].type`	`= "marketplace.bid.withdrawn"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[7].data.bid_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].type`	`= "marketplace.listing.published"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[8].data.listing_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].type`	`= "marketplace.listing.withdrawn"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[9].data.listing_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].type`	`= "community.post.published"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[10].data.post_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].type`	`= "message.received"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].data.chat_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[11].data.message_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].id`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].type`	`= "webhook.test"`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].schema_version`	`= 1`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].occurred_at`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].environment`	`string ["rc","preview","production"]`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].data`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[0].oneOf[12].data.endpoint_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.payload.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.attempts[].AttemptNumber`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.attempts[].AttemptNumber.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].AttemptNumber.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].CompletedDate`		`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].CompletedDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].CompletedDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].HTTPStatus`		`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].HTTPStatus.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.attempts[].HTTPStatus.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].HTTPStatus.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].HTTPStatus.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].DurationMilliseconds`		`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].DurationMilliseconds.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.attempts[].DurationMilliseconds.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].DurationMilliseconds.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].DurationMilliseconds.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].Error`		`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].Error.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].Error.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].ResponseExcerpt`		`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].ResponseExcerpt.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.attempts[].ResponseExcerpt.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.next_attempt_before`		`Да`	Exclusive cursor for the next page of older attempts; null when exhausted.
`$.oneOf[0].allOf[1].Payload.next_attempt_before.anyOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.next_attempt_before.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "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
    }
}

Машиночитаемая документация метода

GET

/v1/event/get_delivery_history

#

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

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`endpointID`	`int`	`Нет`	`0`	Optional endpoint filter.
`eventAlias`	`string`	`Нет`	`""`	Optional catalog event alias.
`status`	`string`	`Нет`	`""`	Optional pending, retry, sending, delivered, failed or cancelled filter.
`beforeID`	`int`	`Нет`	`0`	Exclusive delivery cursor.
`fromDate`	`string`	`Нет`	`""`	Inclusive server date, YYYY-MM-DD.
`toDate`	`string`	`Нет`	`""`	Inclusive server date, YYYY-MM-DD.

Пример запроса (cURL)

curl --get \
  'https://ru.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}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`event_get_delivery_history_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].EndpointID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].EndpointID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].EndpointID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].EventID`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].EventAlias`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].Status`	`string ["pending","retry","sending","delivered","failed","cancelled"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].AttemptCount`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].AttemptCount.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].AttemptCount.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].LastHTTPStatus`		`Да`
`$.oneOf[0].allOf[1].Payload[].LastHTTPStatus.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].LastHTTPStatus.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].LastHTTPStatus.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].LastHTTPStatus.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload[].LastError`		`Да`
`$.oneOf[0].allOf[1].Payload[].LastError.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].LastError.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/get_delivery_history",
    "RequestUserAlias": "example-user",
    "Payload": []
}

Машиночитаемая документация метода

GET

/v1/event/get_status

#

Returns webhook queue health for your endpoints.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/event/get_status' \
  --data-urlencode 'key={{API_KEY}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`event_get_status_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].Status`	`string ["pending","retry","sending","delivered","failed","cancelled"]`	`Да`
`$.oneOf[0].allOf[1].Payload[].Count`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].Count.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].Count.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].OldestDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].OldestAgeSeconds`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/get_status",
    "RequestUserAlias": "example-user",
    "Payload": []
}

Машиночитаемая документация метода

GET

/v1/event/get_subscriptions

#

Returns your endpoints and their selected event topics. Signing secrets are never included.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/event/get_subscriptions' \
  --data-urlencode 'key={{API_KEY}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`event_get_subscriptions_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].URL`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].Enabled`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].Enabled.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].Enabled.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].Revision`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].Revision.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload[].Revision.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload[].Events`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload[].Events[]`	`string`	`Нет`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/get_subscriptions",
    "RequestUserAlias": "example-user",
    "Payload": []
}

Машиночитаемая документация метода

POST

/v1/event/set_delete_endpoint

#

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

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`endpointID`	`int`	`Да`	`—`	Your endpoint ID.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to perform this write.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/event/set_delete_endpoint' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'endpointID={{endpointID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`event_set_delete_endpoint_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.endpoint_id`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_delete_endpoint",
    "RequestUserAlias": "example-user",
    "Payload": {
        "endpoint_id": 0
    }
}

Машиночитаемая документация метода

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.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`name`	`string`	`Да`	`—`	Display name.
`url`	`string`	`Да`	`—`	Public HTTPS destination on port 443.
`eventAliasesJSON`	`string`	`Да`	`—`	JSON array of event aliases.
`endpointID`	`int`	`Нет`	`0`	Zero creates a new endpoint.
`enabled`	`bool`	`Нет`	`true`	Whether to receive events.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to perform this write.

Пример запроса (cURL)

curl --request POST \
  'https://ru.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}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Параметры: eventAliasesJSON

Поле	Тип	Обязательно
`eventAliasesJSON`	`string (application/json)`	`Да`
`eventAliasesJSON`	`array (декодированный JSON)`	`Да`
`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"]`	`Нет`

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`event_set_endpoint_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.endpoint_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.signing_secret`	`string`	`Нет`	Returned only at creation; store securely. Example values are fake.
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_endpoint",
    "RequestUserAlias": "example-user",
    "Payload": {
        "endpoint_id": 0
    }
}

Машиночитаемая документация метода

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.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`deliveryID`	`int`	`Да`	`—`	Delivery ID from your history.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to perform this write.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/event/set_resend' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'deliveryID={{deliveryID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`event_set_resend_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.delivery_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.queued`	`= true`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_resend",
    "RequestUserAlias": "example-user",
    "Payload": {
        "delivery_id": 0,
        "queued": true
    }
}

Машиночитаемая документация метода

POST

/v1/event/set_rotate_secret

#

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

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`endpointID`	`int`	`Да`	`—`	Your endpoint ID.
`revokeImmediately`	`bool`	`Нет`	`false`	Immediately revoke the previous key instead of overlapping.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to perform this write.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/event/set_rotate_secret' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'endpointID={{endpointID}}' \
  --data-urlencode 'revokeImmediately={{revokeImmediately}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`event_set_rotate_secret_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.endpoint_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.signing_secret`	`string`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "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"
    }
}

Машиночитаемая документация метода

POST

/v1/event/set_subscribe

#

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

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`webhookAlias`	`string`	`Да`	`—`	Catalog alias.
`url`	`string`	`Да`	`—`	Public HTTPS destination.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to perform this write.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/event/set_subscribe' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'webhookAlias={{webhookAlias}}' \
  --data-urlencode 'url={{url}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`event_set_subscribe_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.endpoint_id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.signing_secret`	`string`	`Нет`	Returned only at creation; store securely. Example values are fake.
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_subscribe",
    "RequestUserAlias": "example-user",
    "Payload": {
        "endpoint_id": 0
    }
}

Машиночитаемая документация метода

POST

/v1/event/set_test

#

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

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`endpointID`	`int`	`Да`	`—`	Your endpoint ID.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to perform this write.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/event/set_test' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'endpointID={{endpointID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`event_set_test_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.event_id`	`string`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_test",
    "RequestUserAlias": "example-user",
    "Payload": {
        "event_id": "synthetic-example"
    }
}

Машиночитаемая документация метода

POST

/v1/event/set_unsubscribe

#

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

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`endpointID`	`int`	`Да`	`—`	Your endpoint ID.
`webhookAlias`	`string`	`Да`	`—`	Event alias to remove.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to perform this write.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/event/set_unsubscribe' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'endpointID={{endpointID}}' \
  --data-urlencode 'webhookAlias={{webhookAlias}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`event_set_unsubscribe_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.endpoint_id`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/event/set_unsubscribe",
    "RequestUserAlias": "example-user",
    "Payload": {
        "endpoint_id": 0
    }
}

Машиночитаемая документация метода