AlayaMarket Offers External Events API 1.0.0 documentation

AlayaMarket Offers External Events API 1.0.0

application/json

Async API for external Offer events using AWS SNS as a broker.

Generally, subscriptions are expected to be https endpoints. In such cases, the messages described in this document will be stringified json data within the Message of the payload.

For more information see https://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.prepare.html

Servers

https://api.{env}.alayamarket.{region}httpslive
Sandbox server
object
env
required
string
Server environment

Default value:"prod"
Allowed values:
"staging"
"sandbox"
"prod"
region
required
string
Server region

Default value:"ca"
Allowed values:
"ca"
"com"
"com.au"

Operations

SEND outbox-form-submissions
Subscribe demand participants to outbox form submission events published by the service.

Operation IDsub_outbox_form_submissions
Available only on servers:
- live
Accepts the following message:
Outbox form received eventmessage_outbox_form_submission
Inform relevant demand participants about a form submission received
application/json
Message IDmessage_outbox_form_submission
object
event_id
required
string
format: uuid
ID of the event

event_name
required
string
Name of the event.

Allowed values:
"FormSubmissionSupplyApproved"
event_source
required
string
Source of the event.

Const:"alayamarket.forms"
form_submission_id
required
string
format: uuid
ID of the form submission

id
deprecated
string
format: uuid
ID of the event

referral_id
required
string
format: uuid
ID of the related referral

service_id
string
format: uuid
ID of the related service

visit_id
string
format: uuid
ID of the related visit

timestamp
required
string
format: datetime
Timestamp of the event

Additional properties are allowed.
Examples
{ "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "event_name": "FormSubmissionSupplyApproved", "event_source": "alayamarket.forms", "form_submission_id": "1e258e66-9f8a-4dc7-bb55-8e9f6565bb4f", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "referral_id": "2d946960-d63d-4137-b67f-4dc8d4a3067c", "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0", "visit_id": "4fa595bd-6c49-4a9e-9507-63e9ca0eb0fc", "timestamp": "string" }

This example has been generated automatically.
SEND outbox-messages
Subscribe demand participants to outbox message events published by the service.

Operation IDsub_outbox_messages
Available only on servers:
- live
Accepts the following message:
Outbox message received eventmessage_outbox_message
Inform relevant demand participants about a message received
application/json
Message IDmessage_outbox_message
allOf
object
event_source
required
string
Source of the event.

Const:"alayamarket.messages"
id
deprecated
string
format: uuid
ID of the event

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

message_id
required
string
format: uuid
ID of the message

required
object
id
required
string
format: uuid
ID of the sender

name
required
string
Name of the sender

Additional properties are allowed.
category
required
string
Category of the message.

Allowed values:
"client_attachment"
"comment"
offer_id
string
format: uuid
ID of the related offer

referral_id
string
format: uuid
ID of the related referral

sequence_id
required
string
format: uuid
ID of the related sequence

object
id
required
string
format: uuid
ID of the attached file

name
required
string
Name of the attached file

Additional properties are allowed.
Additional properties are allowed.
object
event_name
required
string
Name of the event.

Allowed values:
"MessageSupplySent"
Additional properties are allowed.
Examples
{ "event_source": "alayamarket.messages", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "timestamp": "string", "message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2", "sender": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "category": "client_attachment", "offer_id": "d5a7a5b7-a4a3-49e7-9c69-b44d2cbe15cf", "referral_id": "2d946960-d63d-4137-b67f-4dc8d4a3067c", "sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f", "file": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "event_name": "MessageSupplySent" }

This example has been generated automatically.
SEND outbox-offers
Subscribe demand participants to outbox offer events published by the service.

Operation IDsub_outbox_offers
Available only on servers:
- live
Accepts the following message:
Outbox offer state change eventmessage_outbox_offer
Inform relevant demand participants about a change to the offer state
application/json
Message IDmessage_outbox_offer
object
event_source
required
string
Source of the event.

Const:"alayamarket.offers"
event_name
required
string
Name of the event.

Allowed values:
"OfferAccepted"
"OfferDeclined"
"OfferDeclinedByAll"
"OfferExpired"
id
required
deprecated
string
format: uuid
ID of the offer

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

offer_id
required
string
format: uuid
ID of the offer

Additional properties are allowed.
Examples
{ "event_source": "alayamarket.offers", "event_name": "OfferAccepted", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "timestamp": "string", "offer_id": "d5a7a5b7-a4a3-49e7-9c69-b44d2cbe15cf" }

This example has been generated automatically.
SEND outbox-referrals
Subscribe demand participants to outbox referral events published by the service.

Operation IDsub_outbox_referrals
Available only on servers:
- live
Accepts the following message:
Outbox referral state change eventmessage_outbox_referral
Inform relevant demand participants about a change to the referral state
application/json
Message IDmessage_outbox_referral
object
event_source
required
string
Source of the event.

Const:"alayamarket.referrals"
event_name
required
string
Name of the event.

Allowed values:
"ReferralCreated"
"ReferralProcessed"
"ReferralSupplyCancelled"
id
required
deprecated
string
format: uuid
ID of the referral

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

referral_id
required
string
format: uuid
ID of the referral

sequence_id
string
format: uuid
ID of the sequence the referral belongs to

required
object
outbox_id
required
string
ID of the client in the demand system

id
required
string
format: UUID
ID of the client

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the demand organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the supply organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "event_source": "alayamarket.referrals", "event_name": "ReferralCreated", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "timestamp": "string", "referral_id": "2d946960-d63d-4137-b67f-4dc8d4a3067c", "sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f", "client": { "outbox_id": "string", "id": "string" }, "demand": { "name": "string", "host": "https://org.alayacare.com", "source": "string" }, "supply": { "name": "string", "host": "https://org.alayacare.com", "source": "string" } }

This example has been generated automatically.
SEND outbox-visits
Subscribe demand participants to outbox visit events published by the service. This is only supported for offers of type 'service'.

Operation IDsub_outbox_visits
Available only on servers:
- live
Accepts the following message:
Outbox visit state change eventmessage_outbox_visit
Inform relevant demand participants about a change to the visit state
application/json
Message IDmessage_outbox_visit
object
event_source
required
string
Source of the event.

Const:"alayamarket.visits"
event_name
required
string
Name of the event.

Allowed values:
"VisitSupplyAssigned"
"VisitSupplyDeleted"
"VisitSupplyScheduled"
"VisitSupplyStatusChanged"
"VisitSupplyRescheduled"
"VisitSupplyUnassigned"
id
required
deprecated
string
format: uuid
ID of the visit

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

visit_id
required
string
format: uuid
ID of the visit

referral_id
required
string
format: uuid
ID of the referral

start_at
required
string
format: date-time
Start date-time of the visit.

This is a mutable property and should be used carefully.

end_at
required
string
format: date-time
End date-time of the visit.

This is a mutable property and should be used carefully.

required
object
id
required
string
format: uuid
ID of the service.

outbox_id
required
string
ID of the service in the demand system.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "event_source": "alayamarket.visits", "event_name": "VisitSupplyAssigned", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "timestamp": "string", "visit_id": "4fa595bd-6c49-4a9e-9507-63e9ca0eb0fc", "referral_id": "2d946960-d63d-4137-b67f-4dc8d4a3067c", "start_at": "2019-08-24T14:15:22Z", "end_at": "2019-08-24T14:15:22Z", "service": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "outbox_id": "string" } }

This example has been generated automatically.
SEND outbox-visit-tasks
Subscribe demand participants to outbox visit task events published by the service. This is only supported for offers of type 'visit'.

Operation IDsub_outbox_visit_tasks
Available only on servers:
- live
Accepts the following message:
Outbox visit task state change eventmessage_outbox_visit_task
Inform relevant demand participants about a change to one (or more) visit task state
application/json
Message IDmessage_outbox_visit_task
object
event_source
required
string
Source of the event.

Const:"alayamarket.visit_tasks"
event_name
required
string
Name of the event.

Allowed values:
"VisitTasksCompleted"
id
required
deprecated
string
format: uuid
ID of the visit.

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

visit_id
required
string
format: uuid
ID of the visit

visit_outbox_id
string
ID of the visit in the demand system associated with the visit. This is available for visit type referrals only.

required
array<object>
object
id
required
string
format: uuid
ID of the visit task.

outbox_id
required
string
ID of the visit task in the demand system.

is_completed
required
boolean
Is the visit task completed?

completed_at
string
format: date-time
The date-time at which the visit task was completed.

completion_comment
string
Comment related to the completion of the visit task.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "event_source": "alayamarket.visit_tasks", "event_name": "VisitTasksCompleted", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "timestamp": "string", "visit_id": "4fa595bd-6c49-4a9e-9507-63e9ca0eb0fc", "visit_outbox_id": "string", "tasks": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "outbox_id": "string", "is_completed": true, "completed_at": "2019-08-24T14:15:22Z", "completion_comment": "string" } ] }

This example has been generated automatically.
SEND outbox-work-sessions
Subscribe demand participants to outbox work session events published by the service.

Operation IDsub_outbox_work_sessions
Available only on servers:
- live
Accepts the following message:
Outbox work session state change eventmessage_outbox_work_session
Inform relevant demand participants about a change to the work session state
application/json
Message IDmessage_outbox_work_session
object
event_source
required
string
Source of the event.

Const:"alayamarket.work_sessions"
event_name
required
string
Name of the event.

Allowed values:
"WorkSessionStarted"
"WorkSessionEnded"
id
required
deprecated
string
format: uuid
ID of the work session.

event_id
required
string
format: uuid
ID of the event.

timestamp
required
string
format: datetime
Timestamp of the event.

work_session_id
required
string
format: uuid
ID of the work session.

visit_id
required
string
format: uuid
ID of the visit associated to the work session.

visit_outbox_id
string
format: uuid
ID of the visit in the demand system associated to the work session. This is available for visit type referrals only.

start_at
required
string
format: date-time
Start date-time of the work session.

start_latitude
number
Start latitude of the work session.

start_longitude
number
Start longitude of the work session.

end_at
string
format: date-time
End date-time of the work session. This is required for WorkSessionEnded events only.

end_latitude
number
End latitude of the work session. This is available for WorkSessionEnded events only.

end_longitude
number
End longitude of the work session. This is available for WorkSessionEnded events only.

Additional properties are allowed.
Examples
{ "event_source": "alayamarket.work_sessions", "event_name": "WorkSessionStarted", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "timestamp": "string", "work_session_id": "08cb1cb1-019b-430e-aa31-8ad0ffffc240", "visit_id": "4fa595bd-6c49-4a9e-9507-63e9ca0eb0fc", "visit_outbox_id": "a6345b98-ef7a-458e-851d-64d42fbd891a", "start_at": "2019-08-24T14:15:22Z", "start_latitude": 0, "start_longitude": 0, "end_at": "2019-08-24T14:15:22Z", "end_latitude": 0, "end_longitude": 0 }

This example has been generated automatically.
SEND inbox-form-templates
Subscribe supply participants to inbox form events published by the service.

Operation IDsub_inbox_form_templates
Available only on servers:
- live
Accepts the following message:
Inbox form template received eventmessage_inbox_form_template
Inform relevant supply participants about a new version of a form published
application/json
Message IDmessage_inbox_form_template
object
event_id
required
string
format: uuid
ID of the event

event_name
required
string
Name of the event.

Allowed values:
"FormTemplateDemandPublished"
event_source
required
string
Source of the event.

Const:"alayamarket.form_templates"
demand_persona_id
required
string
format: uuid
ID of the demand org of the form template

id
deprecated
string
format: uuid
ID of the event

schema_id
required
string
format: uuid
Schema ID of the form template

timestamp
required
string
format: datetime
Timestamp of the event

Additional properties are allowed.
Examples
{ "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "event_name": "FormTemplateDemandPublished", "event_source": "alayamarket.form_templates", "demand_persona_id": "498beaf5-05c3-4679-be4c-109db1b986e2", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "schema_id": "9c37f32d-8308-4815-9b0d-83fa3c1b25f9", "timestamp": "string" }

This example has been generated automatically.
SEND inbox-messages
Subscribe supply participants to inbox message events published by the service.

Operation IDsub_inbox_messages
Available only on servers:
- live
Accepts the following message:
Inbox message received eventmessage_inbox_message
Inform relevant supply participants about a message received
application/json
Message IDmessage_inbox_message
allOf
object
event_source
required
string
Source of the event.

Const:"alayamarket.messages"
id
deprecated
string
format: uuid
ID of the event

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

message_id
required
string
format: uuid
ID of the message

required
object
id
required
string
format: uuid
ID of the sender

name
required
string
Name of the sender

Additional properties are allowed.
category
required
string
Category of the message.

Allowed values:
"client_attachment"
"comment"
offer_id
string
format: uuid
ID of the related offer

referral_id
string
format: uuid
ID of the related referral

sequence_id
required
string
format: uuid
ID of the related sequence

object
id
required
string
format: uuid
ID of the attached file

name
required
string
Name of the attached file

Additional properties are allowed.
Additional properties are allowed.
object
event_name
required
string
Name of the event.

Allowed values:
"MessageDemandSent"
Additional properties are allowed.
Examples
{ "event_source": "alayamarket.messages", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "timestamp": "string", "message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2", "sender": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "category": "client_attachment", "offer_id": "d5a7a5b7-a4a3-49e7-9c69-b44d2cbe15cf", "referral_id": "2d946960-d63d-4137-b67f-4dc8d4a3067c", "sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f", "file": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "event_name": "MessageDemandSent" }

This example has been generated automatically.
SEND inbox-offers
Subscribe supply participants to inbox offer events published by the service.

Operation IDsub_inbox_offers
Available only on servers:
- live
Accepts the following message:
Inbox offer state change eventmessage_inbox_offer_event
Inform relevant supply participants about a change to the offer state
application/json
Message IDmessage_inbox_offer_event
object
event_source
required
string
Source of the event.

Const:"alayamarket.offers"
event_name
required
string
Name of the event.

Allowed values:
"OfferMatched"
"OfferClosed"
"OfferExpired"
"OfferFulfilled"
id
required
deprecated
string
format: uuid
ID of the offer

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

offer_id
required
string
format: uuid
ID of the offer

Additional properties are allowed.
Examples
{ "event_source": "alayamarket.offers", "event_name": "OfferMatched", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "timestamp": "string", "offer_id": "d5a7a5b7-a4a3-49e7-9c69-b44d2cbe15cf" }

This example has been generated automatically.
SEND inbox-referrals
Subscribe supply participants to inbox referral events published by the service.

Operation IDsub_inbox_referrals
Available only on servers:
- live
Accepts the following message:
Inbox referral state change eventmessage_inbox_referral
Inform relevant supply participants about a change to the referral state
application/json
Message IDmessage_inbox_referral
object
event_source
required
string
Source of the event.

Const:"alayamarket.referrals"
event_name
required
string
Name of the event.

Allowed values:
"ReferralCreated"
"ReferralDemandCancelled"
id
required
deprecated
string
format: uuid
ID of the referral

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

referral_id
required
string
format: uuid
ID of the referral

sequence_id
string
format: uuid
ID of the sequence the referral belongs to

required
object
outbox_id
required
string
ID of the client in the demand system

id
required
string
format: UUID
ID of the client

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the demand organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the supply organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "event_source": "alayamarket.referrals", "event_name": "ReferralCreated", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "timestamp": "string", "referral_id": "2d946960-d63d-4137-b67f-4dc8d4a3067c", "sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f", "client": { "outbox_id": "string", "id": "string" }, "demand": { "name": "string", "host": "https://org.alayacare.com", "source": "string" }, "supply": { "name": "string", "host": "https://org.alayacare.com", "source": "string" } }

This example has been generated automatically.

Messages

#1Outbox form received eventmessage_outbox_form_submission
Inform relevant demand participants about a form submission received
- application/json
Message IDmessage_outbox_form_submission
object
event_id
required
string
format: uuid
ID of the event

event_name
required
string
Name of the event.

Allowed values:
"FormSubmissionSupplyApproved"
event_source
required
string
Source of the event.

Const:"alayamarket.forms"
form_submission_id
required
string
format: uuid
ID of the form submission

id
deprecated
string
format: uuid
ID of the event

referral_id
required
string
format: uuid
ID of the related referral

service_id
string
format: uuid
ID of the related service

visit_id
string
format: uuid
ID of the related visit

timestamp
required
string
format: datetime
Timestamp of the event

Additional properties are allowed.
#2Outbox message received eventmessage_outbox_message
Inform relevant demand participants about a message received
- application/json
Message IDmessage_outbox_message
allOf
object
event_source
required
string
Source of the event.

Const:"alayamarket.messages"
id
deprecated
string
format: uuid
ID of the event

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

message_id
required
string
format: uuid
ID of the message

required
object
id
required
string
format: uuid
ID of the sender

name
required
string
Name of the sender

Additional properties are allowed.
category
required
string
Category of the message.

Allowed values:
"client_attachment"
"comment"
offer_id
string
format: uuid
ID of the related offer

referral_id
string
format: uuid
ID of the related referral

sequence_id
required
string
format: uuid
ID of the related sequence

object
id
required
string
format: uuid
ID of the attached file

name
required
string
Name of the attached file

Additional properties are allowed.
Additional properties are allowed.
object
event_name
required
string
Name of the event.

Allowed values:
"MessageSupplySent"
Additional properties are allowed.
#3Outbox offer state change eventmessage_outbox_offer
Inform relevant demand participants about a change to the offer state
- application/json
Message IDmessage_outbox_offer
object
event_source
required
string
Source of the event.

Const:"alayamarket.offers"
event_name
required
string
Name of the event.

Allowed values:
"OfferAccepted"
"OfferDeclined"
"OfferDeclinedByAll"
"OfferExpired"
id
required
deprecated
string
format: uuid
ID of the offer

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

offer_id
required
string
format: uuid
ID of the offer

Additional properties are allowed.
#4Outbox referral state change eventmessage_outbox_referral
Inform relevant demand participants about a change to the referral state
- application/json
Message IDmessage_outbox_referral
object
event_source
required
string
Source of the event.

Const:"alayamarket.referrals"
event_name
required
string
Name of the event.

Allowed values:
"ReferralCreated"
"ReferralProcessed"
"ReferralSupplyCancelled"
id
required
deprecated
string
format: uuid
ID of the referral

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

referral_id
required
string
format: uuid
ID of the referral

sequence_id
string
format: uuid
ID of the sequence the referral belongs to

required
object
outbox_id
required
string
ID of the client in the demand system

id
required
string
format: UUID
ID of the client

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the demand organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the supply organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
Additional properties are allowed.
#5Outbox visit state change eventmessage_outbox_visit
Inform relevant demand participants about a change to the visit state
- application/json
Message IDmessage_outbox_visit
object
event_source
required
string
Source of the event.

Const:"alayamarket.visits"
event_name
required
string
Name of the event.

Allowed values:
"VisitSupplyAssigned"
"VisitSupplyDeleted"
"VisitSupplyScheduled"
"VisitSupplyStatusChanged"
"VisitSupplyRescheduled"
"VisitSupplyUnassigned"
id
required
deprecated
string
format: uuid
ID of the visit

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

visit_id
required
string
format: uuid
ID of the visit

referral_id
required
string
format: uuid
ID of the referral

start_at
required
string
format: date-time
Start date-time of the visit.

This is a mutable property and should be used carefully.

end_at
required
string
format: date-time
End date-time of the visit.

This is a mutable property and should be used carefully.

required
object
id
required
string
format: uuid
ID of the service.

outbox_id
required
string
ID of the service in the demand system.

Additional properties are allowed.
Additional properties are allowed.
#6Outbox visit task state change eventmessage_outbox_visit_task
Inform relevant demand participants about a change to one (or more) visit task state
- application/json
Message IDmessage_outbox_visit_task
object
event_source
required
string
Source of the event.

Const:"alayamarket.visit_tasks"
event_name
required
string
Name of the event.

Allowed values:
"VisitTasksCompleted"
id
required
deprecated
string
format: uuid
ID of the visit.

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

visit_id
required
string
format: uuid
ID of the visit

visit_outbox_id
string
ID of the visit in the demand system associated with the visit. This is available for visit type referrals only.

required
array<object>
object
id
required
string
format: uuid
ID of the visit task.

outbox_id
required
string
ID of the visit task in the demand system.

is_completed
required
boolean
Is the visit task completed?

completed_at
string
format: date-time
The date-time at which the visit task was completed.

completion_comment
string
Comment related to the completion of the visit task.

Additional properties are allowed.
Additional properties are allowed.
#7Outbox work session state change eventmessage_outbox_work_session
Inform relevant demand participants about a change to the work session state
- application/json
Message IDmessage_outbox_work_session
object
event_source
required
string
Source of the event.

Const:"alayamarket.work_sessions"
event_name
required
string
Name of the event.

Allowed values:
"WorkSessionStarted"
"WorkSessionEnded"
id
required
deprecated
string
format: uuid
ID of the work session.

event_id
required
string
format: uuid
ID of the event.

timestamp
required
string
format: datetime
Timestamp of the event.

work_session_id
required
string
format: uuid
ID of the work session.

visit_id
required
string
format: uuid
ID of the visit associated to the work session.

visit_outbox_id
string
format: uuid
ID of the visit in the demand system associated to the work session. This is available for visit type referrals only.

start_at
required
string
format: date-time
Start date-time of the work session.

start_latitude
number
Start latitude of the work session.

start_longitude
number
Start longitude of the work session.

end_at
string
format: date-time
End date-time of the work session. This is required for WorkSessionEnded events only.

end_latitude
number
End latitude of the work session. This is available for WorkSessionEnded events only.

end_longitude
number
End longitude of the work session. This is available for WorkSessionEnded events only.

Additional properties are allowed.
#8Inbox form template received eventmessage_inbox_form_template
Inform relevant supply participants about a new version of a form published
- application/json
Message IDmessage_inbox_form_template
object
event_id
required
string
format: uuid
ID of the event

event_name
required
string
Name of the event.

Allowed values:
"FormTemplateDemandPublished"
event_source
required
string
Source of the event.

Const:"alayamarket.form_templates"
demand_persona_id
required
string
format: uuid
ID of the demand org of the form template

id
deprecated
string
format: uuid
ID of the event

schema_id
required
string
format: uuid
Schema ID of the form template

timestamp
required
string
format: datetime
Timestamp of the event

Additional properties are allowed.
#9Inbox message received eventmessage_inbox_message
Inform relevant supply participants about a message received
- application/json
Message IDmessage_inbox_message
allOf
object
event_source
required
string
Source of the event.

Const:"alayamarket.messages"
id
deprecated
string
format: uuid
ID of the event

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

message_id
required
string
format: uuid
ID of the message

required
object
id
required
string
format: uuid
ID of the sender

name
required
string
Name of the sender

Additional properties are allowed.
category
required
string
Category of the message.

Allowed values:
"client_attachment"
"comment"
offer_id
string
format: uuid
ID of the related offer

referral_id
string
format: uuid
ID of the related referral

sequence_id
required
string
format: uuid
ID of the related sequence

object
id
required
string
format: uuid
ID of the attached file

name
required
string
Name of the attached file

Additional properties are allowed.
Additional properties are allowed.
object
event_name
required
string
Name of the event.

Allowed values:
"MessageDemandSent"
Additional properties are allowed.
#10Inbox offer state change eventmessage_inbox_offer_event
Inform relevant supply participants about a change to the offer state
- application/json
Message IDmessage_inbox_offer_event
object
event_source
required
string
Source of the event.

Const:"alayamarket.offers"
event_name
required
string
Name of the event.

Allowed values:
"OfferMatched"
"OfferClosed"
"OfferExpired"
"OfferFulfilled"
id
required
deprecated
string
format: uuid
ID of the offer

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

offer_id
required
string
format: uuid
ID of the offer

Additional properties are allowed.
#11Inbox referral state change eventmessage_inbox_referral
Inform relevant supply participants about a change to the referral state
- application/json
Message IDmessage_inbox_referral
object
event_source
required
string
Source of the event.

Const:"alayamarket.referrals"
event_name
required
string
Name of the event.

Allowed values:
"ReferralCreated"
"ReferralDemandCancelled"
id
required
deprecated
string
format: uuid
ID of the referral

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

referral_id
required
string
format: uuid
ID of the referral

sequence_id
string
format: uuid
ID of the sequence the referral belongs to

required
object
outbox_id
required
string
ID of the client in the demand system

id
required
string
format: UUID
ID of the client

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the demand organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the supply organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
Additional properties are allowed.

Schemas

object
event_source
required
string
Source of the event.

Const:"alayamarket.messages"
id
deprecated
string
format: uuid
ID of the event

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

message_id
required
string
format: uuid
ID of the message

required
object
id
required
string
format: uuid
ID of the sender

name
required
string
Name of the sender

Additional properties are allowed.
category
required
string
Category of the message.

Allowed values:
"client_attachment"
"comment"
offer_id
string
format: uuid
ID of the related offer

referral_id
string
format: uuid
ID of the related referral

sequence_id
required
string
format: uuid
ID of the related sequence

object
id
required
string
format: uuid
ID of the attached file

name
required
string
Name of the attached file

Additional properties are allowed.
Additional properties are allowed.
allOf
object
event_source
required
string
Source of the event.

Const:"alayamarket.messages"
id
deprecated
string
format: uuid
ID of the event

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

message_id
required
string
format: uuid
ID of the message

required
object
id
required
string
format: uuid
ID of the sender

name
required
string
Name of the sender

Additional properties are allowed.
category
required
string
Category of the message.

Allowed values:
"client_attachment"
"comment"
offer_id
string
format: uuid
ID of the related offer

referral_id
string
format: uuid
ID of the related referral

sequence_id
required
string
format: uuid
ID of the related sequence

object
id
required
string
format: uuid
ID of the attached file

name
required
string
Name of the attached file

Additional properties are allowed.
Additional properties are allowed.
object
event_name
required
string
Name of the event.

Allowed values:
"MessageDemandSent"
Additional properties are allowed.
object
event_id
required
string
format: uuid
ID of the event

event_name
required
string
Name of the event.

Allowed values:
"FormSubmissionSupplyApproved"
event_source
required
string
Source of the event.

Const:"alayamarket.forms"
form_submission_id
required
string
format: uuid
ID of the form submission

id
deprecated
string
format: uuid
ID of the event

referral_id
required
string
format: uuid
ID of the related referral

service_id
string
format: uuid
ID of the related service

visit_id
string
format: uuid
ID of the related visit

timestamp
required
string
format: datetime
Timestamp of the event

Additional properties are allowed.
allOf
object
event_source
required
string
Source of the event.

Const:"alayamarket.messages"
id
deprecated
string
format: uuid
ID of the event

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

message_id
required
string
format: uuid
ID of the message

required
object
id
required
string
format: uuid
ID of the sender

name
required
string
Name of the sender

Additional properties are allowed.
category
required
string
Category of the message.

Allowed values:
"client_attachment"
"comment"
offer_id
string
format: uuid
ID of the related offer

referral_id
string
format: uuid
ID of the related referral

sequence_id
required
string
format: uuid
ID of the related sequence

object
id
required
string
format: uuid
ID of the attached file

name
required
string
Name of the attached file

Additional properties are allowed.
Additional properties are allowed.
object
event_name
required
string
Name of the event.

Allowed values:
"MessageSupplySent"
Additional properties are allowed.
object
event_source
required
string
Source of the event.

Const:"alayamarket.offers"
event_name
required
string
Name of the event.

Allowed values:
"OfferAccepted"
"OfferDeclined"
"OfferDeclinedByAll"
"OfferExpired"
id
required
deprecated
string
format: uuid
ID of the offer

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

offer_id
required
string
format: uuid
ID of the offer

Additional properties are allowed.
object
event_source
required
string
Source of the event.

Const:"alayamarket.referrals"
event_name
required
string
Name of the event.

Allowed values:
"ReferralCreated"
"ReferralProcessed"
"ReferralSupplyCancelled"
id
required
deprecated
string
format: uuid
ID of the referral

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

referral_id
required
string
format: uuid
ID of the referral

sequence_id
string
format: uuid
ID of the sequence the referral belongs to

required
object
outbox_id
required
string
ID of the client in the demand system

id
required
string
format: UUID
ID of the client

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the demand organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the supply organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
Additional properties are allowed.
object
event_source
required
string
Source of the event.

Const:"alayamarket.visits"
event_name
required
string
Name of the event.

Allowed values:
"VisitSupplyAssigned"
"VisitSupplyDeleted"
"VisitSupplyScheduled"
"VisitSupplyStatusChanged"
"VisitSupplyRescheduled"
"VisitSupplyUnassigned"
id
required
deprecated
string
format: uuid
ID of the visit

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

visit_id
required
string
format: uuid
ID of the visit

referral_id
required
string
format: uuid
ID of the referral

start_at
required
string
format: date-time
Start date-time of the visit.

This is a mutable property and should be used carefully.

end_at
required
string
format: date-time
End date-time of the visit.

This is a mutable property and should be used carefully.

required
object
id
required
string
format: uuid
ID of the service.

outbox_id
required
string
ID of the service in the demand system.

Additional properties are allowed.
Additional properties are allowed.
object
event_source
required
string
Source of the event.

Const:"alayamarket.visit_tasks"
event_name
required
string
Name of the event.

Allowed values:
"VisitTasksCompleted"
id
required
deprecated
string
format: uuid
ID of the visit.

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

visit_id
required
string
format: uuid
ID of the visit

visit_outbox_id
string
ID of the visit in the demand system associated with the visit. This is available for visit type referrals only.

required
array<object>
object
id
required
string
format: uuid
ID of the visit task.

outbox_id
required
string
ID of the visit task in the demand system.

is_completed
required
boolean
Is the visit task completed?

completed_at
string
format: date-time
The date-time at which the visit task was completed.

completion_comment
string
Comment related to the completion of the visit task.

Additional properties are allowed.
Additional properties are allowed.
object
event_source
required
string
Source of the event.

Const:"alayamarket.work_sessions"
event_name
required
string
Name of the event.

Allowed values:
"WorkSessionStarted"
"WorkSessionEnded"
id
required
deprecated
string
format: uuid
ID of the work session.

event_id
required
string
format: uuid
ID of the event.

timestamp
required
string
format: datetime
Timestamp of the event.

work_session_id
required
string
format: uuid
ID of the work session.

visit_id
required
string
format: uuid
ID of the visit associated to the work session.

visit_outbox_id
string
format: uuid
ID of the visit in the demand system associated to the work session. This is available for visit type referrals only.

start_at
required
string
format: date-time
Start date-time of the work session.

start_latitude
number
Start latitude of the work session.

start_longitude
number
Start longitude of the work session.

end_at
string
format: date-time
End date-time of the work session. This is required for WorkSessionEnded events only.

end_latitude
number
End latitude of the work session. This is available for WorkSessionEnded events only.

end_longitude
number
End longitude of the work session. This is available for WorkSessionEnded events only.

Additional properties are allowed.
object
event_id
required
string
format: uuid
ID of the event

event_name
required
string
Name of the event.

Allowed values:
"FormTemplateDemandPublished"
event_source
required
string
Source of the event.

Const:"alayamarket.form_templates"
demand_persona_id
required
string
format: uuid
ID of the demand org of the form template

id
deprecated
string
format: uuid
ID of the event

schema_id
required
string
format: uuid
Schema ID of the form template

timestamp
required
string
format: datetime
Timestamp of the event

Additional properties are allowed.
object
event_source
required
string
Source of the event.

Const:"alayamarket.offers"
event_name
required
string
Name of the event.

Allowed values:
"OfferMatched"
"OfferClosed"
"OfferExpired"
"OfferFulfilled"
id
required
deprecated
string
format: uuid
ID of the offer

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

offer_id
required
string
format: uuid
ID of the offer

Additional properties are allowed.
object
event_source
required
string
Source of the event.

Const:"alayamarket.referrals"
event_name
required
string
Name of the event.

Allowed values:
"ReferralCreated"
"ReferralDemandCancelled"
id
required
deprecated
string
format: uuid
ID of the referral

event_id
required
string
format: uuid
ID of the event

timestamp
required
string
format: datetime
Timestamp of the event

referral_id
required
string
format: uuid
ID of the referral

sequence_id
string
format: uuid
ID of the sequence the referral belongs to

required
object
outbox_id
required
string
ID of the client in the demand system

id
required
string
format: UUID
ID of the client

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the demand organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
required
object
name
required
string
Name of the demand organization

host
string
The host of the supply organization - a fully qualified domain name that starts with "https://" without a trailing slash (e.g. https://org.alayacare.com).

source
required
string
From whom the organization was sourced (e.g. alayacare, procura, staffy, e2e_tests, internal)

Additional properties are allowed.
Additional properties are allowed.

AlayaMarket Offers External Events API 1.0.0

Servers

Operations

SEND outbox-form-submissions

Examples

This example has been generated automatically.

SEND outbox-messages

Examples

This example has been generated automatically.

SEND outbox-offers

Examples

This example has been generated automatically.

SEND outbox-referrals

Examples

This example has been generated automatically.

SEND outbox-visits

Examples

This example has been generated automatically.

SEND outbox-visit-tasks

Examples

This example has been generated automatically.

SEND outbox-work-sessions

Examples

This example has been generated automatically.

SEND inbox-form-templates

Examples

This example has been generated automatically.

SEND inbox-messages

Examples

This example has been generated automatically.

SEND inbox-offers

Examples

This example has been generated automatically.

SEND inbox-referrals

Examples

This example has been generated automatically.

Messages

Schemas