Ingress
The MelodyArc platform services tasks. Tasks are received via webhook.
Sending a task
Tasks are sent to the MelodyArc platform by sending an HTTP request to the ingress endpoint.
Ingress endpoint
The primary endpoint is
https://<domain>.melodyarc.app
, with the default domain being "w". Clients, such as enterprise clients, may have a different domain.
The request must contain key properties within the body.
- organization: The unique identifier of the client organization
- id: External identifier of a task
- dedupe_key: External identifier used to mark a task as unique. This is useful when a task receives an update and servicing should be combined with the previous version of the task.
- type: External indicator of the type of task, usually the same value as
task_type
- task_type: The type of task used within the MelodyArc platform. See task types for standard options.
- data: Data that will be passed into the data token if a configuration is activated.
Example
Following is an example curl request used to create a task.
JWT
A valid JWT will create a task in its assigned organization. Keep the JWT secure and treat it like a password.
curl --location 'https://w.melodyarc.app/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <REPLACE_WITH_JWT>' \
--data '{
"organization_id": "organization_id",
"dedupe_key": "procedure007",
"id": "procedure007",
"type": "expert",
"task_type": "expert",
"data": {
"task": {"intent": "create_procedure"}
}
}'
Updated 2 months ago
Whatβs Next