Show webhook details

GET 
/webhooks/:webhook_id

Shows details for a webhook, by ID.

Request

Path Parameters

webhook_id stringrequired

Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$

The ID of the webhook for which to show details.

Responses

200

A successful request returns the HTTP 200 OK status code and a JSON response body that shows webhook details.

application/json

Schema

Schema

id string

The ID of the webhook.

url urirequired

The URL that is configured to listen on localhost for incoming POST notification messages that contain event information.

Possible values: <= 2048 characters

event_types object[]required

An array of events to which to subscribe your webhook. To subscribe to all events, including events as they are added, specify the asterisk wild card. To replace the event_types array, specify the asterisk wild card. To list all supported events, list available events.

Possible values: <= 500

links object[]

An array of request-related HATEOAS links.

Example (from schema)

{
  "id": "string",
  "url": "string",
  "event_types": [
    {
      "name": "string",
      "description": "string",
      "status": "string",
      "resource_versions": [
        "string"
      ]
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

default

The error response.

application/json

Schema

Schema

name stringrequired

The human-readable, unique name of the error.

message stringrequired

The message that describes the error.

debug_id stringrequired

The PayPal internal ID. Used for correlation purposes.

information_link string

The information link, or URI, that shows detailed information about this error for the developer.

details object[]

An array of additional details about the error.

links object[]

An array of request-related HATEOAS links.

Example (from schema)

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

Loading...