Post
/api/v1/integrations.replayOutgoing
Replay a history entry of an outgoing integration, triggering the integration again with the recorded data.
Any of the following permissions is required:
manage-outgoing-integrationsmanage-own-outgoing-integrations(replays only integrations created by the calling user)
Changelog
| Version | Description |
|---|---|
| 8.7.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authorization token of the user.
Example9HqLlyZOugD_0YdwAJF8V47U3QHXSq
X-User-Id
stringRequired
The user ID of the user.
ExampleaobEdbYhXfu5hkeqG
Body parameters
Example
{
"integrationId": "nvdQuJQ6tE9HRFBzd",
"historyId": "8G2GfBz3prSampleId"
}object
integrationId
string Required
The ID of the outgoing integration.
ExamplenvdQuJQ6tE9HRFBzd
historyId
string Required
The ID of the integration history to replay. Use the Get Integration History endpoint to list history entries.
Example8G2GfBz3prSampleId
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Invalid Parameter
{
"success": false,
"errorType": "invalid-params",
"error": "must have required property 'historyId'"
}Invalid Integration
{
"success": false,
"error": "Invalid integration [error-invalid-integration]",
"errorType": "error-invalid-integration",
"details": {
"method": "replayOutgoingIntegration"
}
}Invalid Integration History
{
"success": false,
"error": "Invalid Integration History [error-invalid-integration-history]",
"errorType": "error-invalid-integration-history",
"details": {
"method": "replayOutgoingIntegration"
}
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string