Integration reference

PayPal Trigger and Action reference

Start from PayPal commerce and dispute events and automate orders, captures, payments, and refunds.

26 Triggers6 ActionsManifests: Trigger v1 · Action v1

Authentication

Store a PayPal REST app Client ID and Client Secret and choose sandbox or live environment.

  • Trigger account type: api_key; reconnect by replace_credentials.
  • Action connection type: api_key; available modes: Connected PayPal app.

Create or reuse the account from a Trigger or Action dialog, or manage it under Settings → Connected accounts. See Authentication and permissions for scopes and access diagnostics, or Connected accounts for reuse, reconnect, revocation, and credential rotation.

Scopes and permissions

The Trigger manifest does not declare a fixed base OAuth scope list. Installation access, API credentials, or the selected event configuration can still control available resources.

View 1 provider permissions or credential requirements

PayPal Client ID and Client Secret

Operation-specific requirements appear in the tables below. Custom event selections can add scopes dynamically, so the current Trigger or Action dialog remains authoritative for the exact consent request.

Use PayPal as a Trigger

The current provider manifest contains 26 available Trigger definitions. Representative definitions include:

  • Checkout Order Approved
  • Checkout Order Completed
  • Payment Capture Completed
  • Payment Capture Declined
  • Customer Dispute Created
  • Billing Subscription Cancelled
View all 26 available Trigger definitions
TriggerManifest keyDeliveryAdditional scopes
Any PayPal Eventpaypal.any_event.instantinstantNone declared
Custom PayPal Eventspaypal.custom_webhook_events.instantinstantNone declared
Checkout · Order · Approvedpaypal.checkout_order_approved.instantinstantNone declared
Checkout · Order · Completedpaypal.checkout_order_completed.instantinstantNone declared
Payment · Authorization · Createdpaypal.payment_authorization_created.instantinstantNone declared
Payment · Authorization · Voidedpaypal.payment_authorization_voided.instantinstantNone declared
Payment · Capture · Completedpaypal.payment_capture_completed.instantinstantNone declared
Payment · Capture · Declinedpaypal.payment_capture_declined.instantinstantNone declared
Payment · Capture · Pendingpaypal.payment_capture_pending.instantinstantNone declared
Payment · Capture · Refundedpaypal.payment_capture_refunded.instantinstantNone declared
Payment · Capture · Reversedpaypal.payment_capture_reversed.instantinstantNone declared
Payment · Refund · Completedpaypal.payment_refund_completed.instantinstantNone declared
Payment · Refund · Failedpaypal.payment_refund_failed.instantinstantNone declared
Payment · Refund · Pendingpaypal.payment_refund_pending.instantinstantNone declared
Customer · Dispute · Createdpaypal.customer_dispute_created.instantinstantNone declared
Customer · Dispute · Updatedpaypal.customer_dispute_updated.instantinstantNone declared
Customer · Dispute · Resolvedpaypal.customer_dispute_resolved.instantinstantNone declared
Billing · Subscription · Createdpaypal.billing_subscription_created.instantinstantNone declared
Billing · Subscription · Activatedpaypal.billing_subscription_activated.instantinstantNone declared
Billing · Subscription · Updatedpaypal.billing_subscription_updated.instantinstantNone declared
Billing · Subscription · Cancelledpaypal.billing_subscription_cancelled.instantinstantNone declared
Billing · Subscription · Suspendedpaypal.billing_subscription_suspended.instantinstantNone declared
Billing · Subscription · Expiredpaypal.billing_subscription_expired.instantinstantNone declared
Payment · Sale · Completedpaypal.payment_sale_completed.instantinstantNone declared
Payment · Sale · Refundedpaypal.payment_sale_refunded.instantinstantNone declared
Payment · Sale · Reversedpaypal.payment_sale_reversed.instantinstantNone declared

Choose the narrowest event definition that fits the Workflow. Configure provider-specific resource and event filters in the Source dialog before adding broader Workflow Filters.

Use PayPal Actions

The current Action manifest contains 6 operations. Representative Actions include:

  • Create Order
  • Get Order
  • Capture Order
  • Get Capture
  • Refund Capture
  • Custom API Request
View all 6 available Action definitions
ActionManifest keyAccess and authManifest rate limit
Create Orderpaypal.create_orderPayPal Client ID and Client Secret
FastHook-managed account
2/second
Get Orderpaypal.get_orderPayPal Client ID and Client Secret
FastHook-managed account
2/second
Capture Orderpaypal.capture_orderPayPal Client ID and Client Secret
FastHook-managed account
2/second
Get Capturepaypal.get_capturePayPal Client ID and Client Secret
FastHook-managed account
2/second
Refund Capturepaypal.refund_capturePayPal Client ID and Client Secret
FastHook-managed account
2/second
Custom API Requestpaypal.custom_api_requestPayPal Client ID and Client Secret
FastHook-managed account
2/second

The Action editor reads its required permissions, fields, remote resource pickers, output schema, and rate limit from the provider manifest. Available fields can change with the selected operation and authentication mode.

Build a Workflow

  1. Create a Source using a PayPal Trigger definition.
  2. Create a Workflow with that Source as its Trigger.
  3. Add the required PayPal Action and select the connected account.
  4. Map Trigger or earlier-Step data into the Action fields with the field picker.
  5. Add a Filter, Paths, Delay, or Transformation when the route needs it.
  6. Activate the Workflow, produce a controlled event, and verify the run in Audit and in PayPal.

Troubleshooting PayPal

The account is missing or cannot be selected
Confirm the active FastHook team, provider, account status, and authentication mode. A disabled or revoked account cannot execute an Action.
A resource picker is empty
Verify that the connected provider identity can access the resource itself. OAuth consent does not add workspace, repository, channel, drive, project, base, or record permissions.
The editor asks for additional scopes
Reconnect the same account from the affected Trigger or Action so FastHook can request its current manifest scopes. Then reopen the editor and select the resource again.
An active Workflow returns 401, 403, or a permission error
Compare the selected operation’s access requirements below with the account recorded in Audit. Check provider-side membership and object access before repeating the Action.
The provider returns 429 or a temporary 5xx
Inspect the Step attempt and retryability in Audit. FastHook can retry temporary failures, but provider quotas and idempotency rules still apply.

Provider-specific checks

  • Keep sandbox and live credentials and Workflows clearly separated.
  • Capture and refund operations need idempotent business controls before retries or manual repetition.

Next