How to: Manage Dispatch

For information about prerequisites, see Integrate with Dispatch.

Create Dispatch Attributes

To create Dispatch Attributes, call the Post Dispatch Attribute endpoint and pass the following required members in the request body:

Also, specify the dispatchTypeId in the path parameter.

The JSON request body should be similar to the following:

{
  "attributes": [
    {
      "name": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "dataType": "string",
      "indexed": false,
      "defaultValue": {},
      "validation": {
        "range": {
          "min": 0,
          "max": 0
        },
        "regex": "string",
        "valueOneOf": [
          "string"
        ],
        "required": false
      }
    }
  ],
  "_event_meta": {}
}

Retrieve Attribute Config of a Dispatch

To retrieve the attributes of a Dispatch, call the Get Dispatch Attribute endpoint and specify the dispatchTypeId in the path parameter.

Create a Dispatch

To create a Dispatch, call the Create Dispatch endpoint and pass the following required members in the request body:

The JSON request body should be similar to the following:

{
  "dispatchRef": "string",
  "dispatchTypeName": "string",
  "dispatchTypeId": "string",
  "jobs": [
    "string"
  ],
  "participants": [
    "string"
  ],
  "customData": {
    "additionalProp1": {}
  },
  "_event_meta": {},
  "additionalProp1": {}
}

Add Job to a Dispatch

To add a Job to a Dispatch, call the Add Job to Dispatch endpoint and pass the following required members in the request body:

The JSON request body should be similar to the following:

{
  "jobId": "string",
  "callback": {
    "url": "string",
    "headers": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "_event_meta": {}
}

To add multiple Jobs to a Dispatch, call the Add Multiple Jobs to Dispatch endpoint and pass the following required members in the request body:

The JSON request body should be similar to the following:

{
  "jobs": [
    "string"
  ],
  "callback": {
    "url": "string",
    "headers": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "_event_meta": {}
}

Add Participant to a Dispatch

To add a Participant to a Dispatch, call the Add Participant to Dispatch endpoint and pass the following required members in the request body:

The JSON request body should be similar to the following:

{
  "participantId": "string",
  "callback": {
    "url": "string",
    "headers": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "_event_meta": {}
}

To add multiple Participants to a Dispatch, call the Add Multiple Participant to Dispatch endpoint and pass the following required members in the request body:

The JSON request body should be similar to the following:

{
  "participants": [
    "string"
  ],
  "_event_meta": {}
}

Update the status and sub-status of a Dispatch

To update the status and sub-status of a Dispatch, call the Change Status and Sub-Status of Dispatch endpoint and pass the required members in the request body. Also, specify the dispatchId in the path parameter.

The JSON request body should be similar to the following:

{
  "status": "CLOSED",
  "subStatus": "string",
  "_event_meta": {}
}

To update the sub-status of a Dispatch, call the Change Sub-Status of Dispatch endpoint and pass the following required members in the request body. Also, specify the dispatchId in the path parameter.

The JSON request body should be similar to the following:

{
  "subStatus": "string",
  "_event_meta": {}
}

Remove Job from a Dispatch

To remove a Job from a Dispatch, call the Remove Job from Dispatch endpoint. Specify dispatchId and jobId in the path parameter.

The JSON request body should be similar to the following:

{
  "_event_meta": {}
}

To remove multiple Jobs from a Dispatch, call the Remove Multiple Jobs from the Dispatch endpoint. Specify dispatchId in the path parameter. Pass the following required members in the request body:

The JSON request body should be similar to the following:

{
  "jobs": [
    "string"
  ],
  "_event_meta": {}
}

Remove Participant from a Dispatch

To remove a Participant from a Dispatch, call the Remove Participant from Dispatch endpoint. Specify dispatchId and participantId in the path parameter.

The JSON request body should be similar to the following:

{
  "_event_meta": {}
}