Skip to content

Receive an async plugin callback

POST /plugin/async-callback/{taskId}

Completes an asynchronous call, SMS or fax plugin task identified by its random task UUID. The UUID is a bearer capability and expires after seven days. A successful call report appends note to the CRM activity; SMS/fax reports only record completion. Terminal tasks retain minimal analytics tombstones until expiry to suppress duplicate callbacks. A plugin-reported failure is acknowledged with HTTP 200.

Operation ID: postPluginAsyncCallback
Authorization: None

Parameters

Name Location Type Required Description
taskId path string Yes Random asynchronous plugin task UUID embedded in the callback URL. Treat it as a bearer capability; tasks expire after seven days.

Request body

Completion report for the task identified by the callback URL. successful describes plugin work, not HTTP transport success.

Required: Yes

Content type: application/json

Schema: AsyncPluginCallbackRequest

{
  "successful": false,
  "note": "string",
  "message": "string"
}

Responses

Status Description Body
200 Async plugin callback result. AsyncPluginCallbackResponse
400 Bad request, missing authentication, or connector error. ErrorResponse, string
404 Async plugin task was not found or expired. AsyncPluginCallbackResponse
500 Callback was valid, but App Connect failed to update the CRM log. AsyncPluginCallbackResponse