n8n-nodes-pega

This is an n8n community node that allows you to interact with the Pega Platform REST API directly from n8n workflows. It enables automation scenarios such as creating cases, retrieving case details, and managing attachments.

Pega API Documentation

Requirements

• n8n version 1.0 or later
• Access to a Pega Platform instance with REST API enabled
• OAuth2 client credentials configured in Pega

Features

• Resource: Case
  • Create: Create a new case in Pega.
  • Get: Retrieve a case by its ID.
  • Upload Attachment: Upload a file to Pega to get an attachment ID.
  • Link Attachment: Link an uploaded attachment to an existing case.

Authentication

This node uses OAuth2 Client Credentials for authentication. You will need:

• Base URL: Your Pega instance URL (e.g., https://<your-instance>.pegace.net/prweb)
• Access Token URL: Typically found at <Base URL>/PRRestService/oauth2/v1/token
• Client ID and Client Secret: Obtained from your Pega application's OAuth2 client registration.

Installation

For Local Development/Testing

1. Clone this repository.
2. Run npm install to install dependencies.
3. Run npm run build to compile the TypeScript code.
4. Copy the compiled dist folder into your n8n custom nodes directory: ~/.n8n/custom/n8n-nodes-pega/

Using npm

(Once published)

1. Go to Settings > Community Nodes in your n8n instance.
2. Click on Install a new node.
3. Enter n8n-nodes-pega and click Install.

Example Workflow

Example automation using the Pega node:

1. Receive a form submission from a webhook.
2. Use the Pega → Create Case operation to create a new case.
3. Upload supporting documents using Upload Attachment.
4. Link the uploaded file to the created case.

This allows automated case creation directly from external systems.

Usage

Creating a Case

1. Add the Pega node to your workflow.
2. Select Resource: Case and Operation: Create.
3. Enter the Case Type ID (e.g., MyOrg-Work-LoanApplication).
4. Provide the case data in the Content field (under Additional Fields) as JSON.

Uploading Attachments

1. Use an HTTP Request or a trigger to get binary data.
2. Add the Pega node with Operation: Upload Attachment.
3. Specify the name of the binary property (default is file).
4. The node will return an ID which you can use in the next step.
5. Add another Pega node with Operation: Link Attachment to link the file to a specific case.

License

MIT