Actions52
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
- Platforms Actions
- Projects Actions
- Webhooks Actions
Overview
This node provides integration with a universal messaging gateway platform, allowing users to manage various resources such as API keys, identities, messages, platforms, projects, and webhooks. Specifically, the Webhooks - List operation enables users to retrieve a list of all webhooks configured for a given project. This is useful for monitoring, auditing, or managing webhook endpoints that receive event notifications from the messaging platform.
Common scenarios include:
- Auditing all active webhooks in a project.
- Retrieving webhook configurations to update or analyze them.
- Integrating webhook management into automated workflows.
Example: A user wants to fetch all webhooks associated with their project "default" to display them in a dashboard or to verify which webhooks are currently active.
Properties
| Name | Meaning |
|---|---|
| Project | Project identifier to operate on (e.g., "default"). Specifies the project whose webhooks will be listed. |
Output
The output JSON contains an array of webhook objects representing each webhook configured in the specified project. Each webhook object typically includes details such as its ID, name, target URL, subscribed events, status (active/inactive), and delivery statistics.
The node does not output binary data.
Dependencies
- Requires an API key credential for authentication with the messaging gateway platform.
- The node makes HTTP GET requests to the endpoint
/api/v1/projects/{project}/webhooksto retrieve the list of webhooks. - The
projectparameter must be provided to specify the scope of the request.
Troubleshooting
- Missing or invalid project identifier: Ensure the
Projectproperty is set correctly; otherwise, the API may return an error or empty results. - Authentication errors: Verify that the API key credential is valid and has sufficient permissions to list webhooks.
- Network issues or API downtime: Check connectivity and the status of the messaging gateway service.
- Empty response: If no webhooks exist for the project, the output will be an empty list.
Links and References
- Messaging Gateway API Documentation (hypothetical link)
- n8n documentation on HTTP Request Node for understanding how API calls are made within nodes