Pipefy icon

Pipefy

Interact with Pipefy GraphQL API
Join our community

Actions17

Overview

This node creates a webhook within a specified organization in Pipefy. It allows users to set up webhooks that listen to specific events related to user activities in the organization, such as invitation acceptance, invitation sent, user removal, and role changes. This is useful for automating workflows or integrating Pipefy events with other systems by triggering actions when these events occur.

Use Case Examples

  1. Automatically notify a team chat when a user accepts an invitation to the organization.
  2. Trigger a workflow to update user roles in an external system when a user's role is set in Pipefy.
  3. Send an email alert when a user is removed from the organization.

Properties

Name Meaning
Authentication Select the authentication method to use for API requests, either a service account or a personal access token.
Name The name of the webhook to be created.
URL The URL endpoint where the webhook will send event notifications.
Org Name or ID The organization in which to create the webhook, selectable from a list or specified by ID.
Events The list of events that the webhook will listen to and trigger on.
Authorization Token A secret token sent in the 'X-Pipefy-Signature' header with each webhook request for security verification.
Additional Fields Optional fields including notification email for the webhook and custom headers to include in webhook requests.

Output

JSON

  • id - The unique identifier of the created webhook.
  • name - The name of the created webhook.
  • url - The URL endpoint of the created webhook.
  • orgId - The organization ID where the webhook was created.
  • events - The list of events the webhook is subscribed to.
  • authorizationToken - The authorization token used for securing webhook requests.
  • notificationEmail - The email address set for webhook notifications, if provided.
  • customHeaders - Any custom headers configured for the webhook requests.

Dependencies

  • Requires API authentication credentials: either a service account API key or a personal access token for Pipefy.

Troubleshooting

  • Ensure the URL provided is a valid and reachable endpoint to receive webhook requests.
  • Verify that the authorization token is a secure, random string to prevent unauthorized access.
  • Check that the organization ID or name is correct and accessible with the provided credentials.
  • Make sure the selected events are valid and supported by Pipefy's webhook system.
  • If custom headers are used, ensure they are correctly formatted as JSON.

Links

Discussion