Jump to

• Request
• Response

externalActionStatus

post

/ccadmin/v1/webhook/externalActionStatus

Notifies external systems about the status of external action.

Request

Supported Media Types

• application/json

Body ()

Notifies external systems about the status of external action.

Root Schema : externalActionStatus_request

Type: object

Notifies external systems about the status of external action.

Show Source

• entityId: string
  The ID of the entity the external action was performed on.
• entityType: string
  The type of the entity the external action was performed on.
• failureCause: string
  The reason for failure if the requestStatus is 'FAILURE'; otherwise, this field is null.
• process: string
  The name of the process that triggered the external action.
• requestStatus: string
  The status of the request.
• returnedStatusCode: string
  The status code returned from the external action.

{
    "description":"Notifies external systems about the status of external action.",
    "properties":{
        "process":{
            "description":"The name of the process that triggered the external action.",
            "type":"string"
        },
        "returnedStatusCode":{
            "description":"The status code returned from the external action.",
            "type":"string"
        },
        "entityType":{
            "description":"The type of the entity the external action was performed on.",
            "type":"string"
        },
        "failureCause":{
            "description":"The reason for failure if the requestStatus is 'FAILURE'; otherwise, this field is null.",
            "type":"string"
        },
        "entityId":{
            "description":"The ID of the entity the external action was performed on.",
            "type":"string"
        },
        "requestStatus":{
            "description":"The status of the request.",
            "type":"string"
        }
    },
    "example":{
        "process":"Order Submission to CPQ",
        "returnedStatusCode":"200",
        "entityType":"order",
        "failureCause":null,
        "entityId":"o111",
        "requestStatus":"SUCCESS"
    }
}

Example:

{
    "process":"Order Submission to CPQ",
    "returnedStatusCode":"200",
    "entityType":"order",
    "failureCause":null,
    "entityId":"o111",
    "requestStatus":"SUCCESS"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

No response is returned as this is an event webhook

Body ()

Root Schema : emptyResponse

Show Source

{
    "properties":{
    }
}

Back to Top