MinistryPlatform icon

MinistryPlatform

Consume MinistryPlatform API for church management data operations

Actions6

Overview

This node integrates with the MinistryPlatform API, a church management system, to perform data operations on various tables or execute stored procedures. It supports common database actions such as creating, retrieving, updating, deleting, and listing records in MinistryPlatform tables. Additionally, it can list and execute stored procedures available in the system.

Typical use cases include:

  • Managing contact information by creating or updating records in the Contacts table.
  • Retrieving event details or participant lists for reporting or automation.
  • Executing stored procedures to run complex queries or batch operations within MinistryPlatform.
  • Deleting obsolete or incorrect records from any specified table.

For example, you could use this node to automatically add new volunteers to the Volunteers table when they sign up via a form, or to fetch all upcoming events for display on a website.

Properties

Name Meaning
Table Name The name of the MinistryPlatform table to interact with. Common tables include: Contacts, Participants, Events, Households, Groups, Donations, Volunteers, etc.

Additional properties relevant to the "Table" resource and "Default" operation (which includes create, get, list, update, delete) are:

Name Meaning
Record ID Unique identifier (primary key) of the record to retrieve or delete. Usually formatted as <TableName>_ID (e.g., Contact_ID).
Records JSON array of record objects to create or update. Each object contains field names and values for that record. Example: [{"Contact_ID": 159, "First_Name": "John", "Last_Name": "Doe"}].
Additional Fields Collection of optional parameters for listing records, including:
- Distinct (boolean): Return only distinct records.
- Filter (string): SQL WHERE clause syntax for filtering.
- Global Filter ID (number).
- Group By (string).
- Having (string).
- Order By (string).
- Search (string): Text search across searchable fields.
- Select (string): Comma-separated list of fields to select.
- Skip (number): Number of records to skip (pagination).
- Top (number): Maximum number of records to return.
- User ID (number): Context-sensitive user ID.

Output

The node outputs an array of JSON objects representing the results of the requested operation:

  • For create and update operations, the output contains the created or updated records as returned by the MinistryPlatform API.
  • For get operation, the output is a single record object matching the specified Record ID.
  • For list operation, the output is an array of records matching the query parameters and filters.
  • For delete operation, the output typically contains confirmation of deletion or an empty response.
  • If errors occur and "Continue On Fail" is enabled, error messages are included in the output per item.

The node does not output binary data.

Dependencies

  • Requires an active connection to the MinistryPlatform API using an API key or authentication token configured in n8n credentials.
  • The node uses HTTP requests to communicate with MinistryPlatform endpoints.
  • Proper permissions in MinistryPlatform are necessary to perform CRUD operations or execute stored procedures.

Troubleshooting

  • Invalid JSON format in records or parameters: When providing JSON input for records or stored procedure parameters, ensure the JSON is correctly formatted. Errors will specify the issue.
  • Record not found: For get or delete operations, specifying an incorrect or non-existent Record ID will result in errors.
  • Permission errors: Insufficient permissions in MinistryPlatform may cause authorization failures.
  • Filtering syntax errors: Filters must follow MS SQL WHERE clause syntax; invalid filters will cause request failures.
  • Empty or missing required fields: Ensure mandatory fields like Table Name and Record ID (where applicable) are provided.

To resolve issues:

  • Validate JSON inputs before running the node.
  • Confirm correct table names and record IDs.
  • Check API credentials and permissions.
  • Review filter and query syntax carefully.

Links and References

  • MinistryPlatform official documentation (for API details and table schemas)
  • MS SQL WHERE clause syntax reference for constructing filters
  • n8n documentation on creating custom nodes and handling JSON inputs

Discussion