PayPal

Webhooks Management

The PayPal REST APIs use webhooks for event notification. Webhooks are HTTP callbacks that receive notification messages for events. After you configure a…

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The PayPal REST APIs use webhooks for event notification. Webhooks are HTTP callbacks that receive notification messages for events. After you configure a webhook listener for your app, you can create a webhook , which subscribes the webhook listener for your app to events. The notifications namespace contains resource collections for webhooks.

Endpoints 16

webhooks

  • GETList webhooks/v1/notifications/webhooks?anchor_type=APPLICATIONLists webhooks for an app.
  • POSTCreate webhook/v1/notifications/webhooksSubscribes your webhook listener to events.
  • GETShow webhook details/v1/notifications/webhooks/:webhook_idShows details for a webhook, by ID.
  • DELETEDelete webhook/v1/notifications/webhooks/:webhook_idDeletes a webhook, by ID.
  • PATCHUpdate webhook/v1/notifications/webhooks/:webhook_idUpdates a webhook to replace webhook fields with new values. Supports only the replace operation. Pass a json_patch object with replace operation and path,…
  • GETList event subscriptions for webhook/v1/notifications/webhooks/:webhook_id/event-typesLists event subscriptions for a webhook, by ID.

webhooks-lookup

  • GETList webhook lookups/v1/notifications/webhooks-lookupLists webhook lookups.
  • POSTCreate webhook lookup/v1/notifications/webhooks-lookupCreates a webhook lookup. A webhook lookup ties the API caller's REST API app to the subject account (or, if no subject is specified, to the API caller's…
  • GETShow webhook lookup details/v1/notifications/webhooks-lookup/:webhook_lookup_idShows details for a webhook lookup, by ID.
  • DELETEDelete webhook lookup/v1/notifications/webhooks-lookup/:webhook_lookup_idDeletes a webhook lookup, by ID.

verify-webhook-signature

  • POSTVerify webhook signature/v1/notifications/verify-webhook-signatureVerifies a webhook signature.

webhooks-event-types

  • GETList available events/v1/notifications/webhooks-event-typesLists available events to which any webhook can subscribe. For a list of supported events, see Webhook event names.

webhooks-events

  • GETList event notifications/v1/notifications/webhooks-events?page_size=10&start_time=string&end_time=string&transaction_id=string&event_type=stringLists webhooks event notifications. Use query parameters to filter the response.
  • GETShow event notification details/v1/notifications/webhooks-events/:event_idShows details for a webhooks event notification, by ID.
  • POSTResend event notification/v1/notifications/webhooks-events/:event_id/resendResends a webhook event notification, by ID. Any pending notifications are not resent.

simulate-event

  • POSTSimulate webhook event/v1/notifications/simulate-eventSimulates a webhook event. In the JSON request body, specify a sample payload.<br>You need to subscribe to the following webhook events for Pay upon…

API details

Base URL
https://api-m.sandbox.paypal.com
https://api-m.paypal.com
Authentication
OAuth 2.0 (client credentials flow) with 2 scopes
Operations
16 operations on 11 pathsGET 8POST 5DELETE 2PATCH 1
Main resources
webhooks 6webhooks-lookup 4webhooks-events 3simulate-event 1verify-webhook-signature 1webhooks-event-types 1
Response formats
application/json
Description format
OpenAPI 3.0.3, API version 1.11

How to test the Webhooks Management in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Webhooks Management collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (client credentials flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List webhooks” (GET /v1/notifications/webhooks?anchor_type=APPLICATION), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Webhooks Management?

The PayPal REST APIs use webhooks for event notification. Webhooks are HTTP callbacks that receive notification messages for events. After you configure a… It is listed under Payments and has 16 endpoints.

Who publishes the Webhooks Management?

It is listed from PayPal's public API description (an OpenAPI document), not published by PayPal on Swastik Codes. Anyone who controls paypal.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Webhooks Management?

Its description lists 2 base URLs: https://api-m.sandbox.paypal.com, https://api-m.paypal.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Webhooks Management?

With OAuth 2.0 (client credentials flow) with 2 scopes.

How many endpoints does the Webhooks Management have?

16 operations on 11 paths (8 GET, 5 POST, 2 DELETE, 1 PATCH). The largest groups are webhooks, webhooks-lookup, webhooks-events, simulate-event.

Is forking the Webhooks Management free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.