API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

EventSubscriber

Retrieves a EventSubscriber resource.

Retrieves a EventSubscriber resource.

Authorizations:
JWT
path Parameters
id
required
string

EventSubscriber identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "shortcode": "ES",
  • "entity": "string",
  • "eventType": "string",
  • "httpMethod": "string",
  • "callbackUrl": "string",
  • "notes": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the EventSubscriber resource.

Replaces the EventSubscriber resource.

Authorizations:
JWT
path Parameters
id
required
string

EventSubscriber identifier

Request Body schema:
required

The updated EventSubscriber resource

entity
string

Entity

eventType
required
string

EventType.

eventKey
string or null

Key.

httpMethod
required
string

HttpMethod.

callbackUrl
required
string
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "entity": "string",
  • "eventType": "string",
  • "eventKey": "string",
  • "httpMethod": "string",
  • "callbackUrl": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "shortcode": "ES",
  • "entity": "string",
  • "eventType": "string",
  • "httpMethod": "string",
  • "callbackUrl": "string",
  • "notes": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the EventSubscriber resource.

Removes the EventSubscriber resource.

Authorizations:
JWT
path Parameters
id
required
string

EventSubscriber identifier

Responses