API ReferenceConnectors
Execute a connector action
POST
/v1/connectors/{connectorId}/actions/{actionId}/executeAuthorization
ApiKeyAuth AuthorizationBearer <token>
API key authentication. Keys are prefixed with environment:
npk_live_for productionnpk_test_for testing/staging
In: header
Path Parameters
connectorId*string
Connector ID
actionId*string
Action ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.npayload.com/v1/connectors/string/actions/string/execute" \ -H "Content-Type: application/json" \ -d '{ "credentialId": "string", "input": {} }'{
"success": true,
"result": {}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "Validation failed",
"details": {
"field": "name",
"reason": "Name is required"
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}Was this page helpful?