Postman Collection
The Postman collection provides a complete set of pre-configured requests for testing all API endpoints, including service discovery, execution requests, and callback responses.
Collection Contents
The collection includes requests for:
- Service Definition - Get service capabilities and configuration
- Execution Requests - Test entity submissions (lead, account,
accountPerson) - Callback Responses - Test callback submissions to Adobe
- Health Check - Verify service availability
Setup
- Download external-actions-postman.json .
- Open Postman Desktop or Web.
- Click Import and select
external-actions-postman.jsonfrom your download location. - Click Import.
Configure Environment Variables
Create a new environment in Postman with these variables:
serviceUrlhttps://your-service.comadobeCallbackUrlhttps://adobe.com/external-actions/callbackapiKeyyour-api-keycallbackTokentest-token-123bearerTokenyour-bearer-tokenor create a Postman environment file:
{
"name": "External Actions - Development",
"values": [
{
"key": "serviceUrl",
"value": "https://dev.your-service.com",
"enabled": true
},
{
"key": "adobeCallbackUrl",
"value": "https://adobe-dev.com/callback",
"enabled": true
},
{
"key": "apiKey",
"value": "dev-api-key",
"enabled": true
},
{
"key": "callbackToken",
"value": "",
"enabled": true
}
]
}
Test Your First Request
- Select Get Service Definition request.
- Ensure your environment is selected.
- Click Send.
- Verify the response matches your service definition.
Testing Workflows
Test Service Definition
Verify your service declares capabilities correctly.
-
Select Get Service Definition
-
Click Send
-
Verify response contains:
supportedEntityTypeinvocationPayloadDefcallbackPayloadDefenableSplitPaths(if applicable)
Test Execution Request
Verify your service accepts and processes execution requests.
-
Select an execution request:
- Execute - Lead Entity
- Execute - Account Entity
- Execute - AccountPerson Entity
-
Customize the request body as needed.
-
Click Send.
-
Verify the response:
- HTTP 201 Created
- Response contains
requestId
Test Callback Response
Verify Adobe accepts your callback responses.
- After your service processes a request, select Callback - Success or Callback - Error.
- Update
callbackTokento match the token from your execution request. - Click Send.
- Verify HTTP 200 OK.
Advanced Features
Dynamic Callback Tokens
Add a pre-request script to generate unique callback tokens for testing:
// Pre-request Script
pm.environment.set("callbackToken", pm.variables.replaceIn('{{$randomUUID}}'));
console.log("Generated callbackToken:", pm.environment.get("callbackToken"));
Response Validation Tests
Add test scripts to validate responses automatically:
// Tests Tab
pm.test("Status code is 200", function () {
pm.response.to.have.status(200);
});
pm.test("Response has required fields", function () {
var jsonData = pm.response.json();
pm.expect(jsonData).to.have.property('status');
pm.expect(jsonData).to.have.property('requestId');
});
pm.test("Response time is acceptable", function () {
pm.expect(pm.response.responseTime).to.be.below(5000);
});
Authentication
API Key Authentication
Set in Headers:
X-API-Key: {{apiKey}}
OAuth 2.0
Set in Authorization:
- Type: Bearer Token
- Token:
{{bearerToken}}
Basic Authentication
Set in Authorization:
- Type: Basic Auth
- Username:
{{username}} - Password:
{{password}}
Testing Scenarios
Scenario 1: Lead Enrichment
- Get Service Definition - Verify lead entity support.
- Execute - Lead Entity - Send lead data.
- Callback - Success - Return enriched data with accessor values.
Scenario 2: Error Handling
- Execute - Lead Entity - Send invalid data.
- Callback - Error - Return error details.
Scenario 3: Split Path Decisioning
- Execute - Lead Entity - Send lead data.
- Callback - Success - Return accessor values for journey routing.