eventSubscriptions

Retrieve event subscription

Changed on

Use this method to retrieve the details of an event subscription.

In your request, include the subscriptionId that we sent to you when we created the event subscription.

Note: If you don't know the subscriptionId of the event subscription, go to List event subscriptions.

get/event-subscriptions/{subscriptionId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/event-subscriptions/{subscriptionId}
  • Auth
    HTTP bearer

Path parameters

subscriptionIdinteger required

Unique identifier that we assigned to the event subscription.
Note: Our gateway returned the subscriptionId in the id field in the response of the Create Event Subscription method.

Response

Returns the event subscription object.

idinteger

Unique identifier that we assigned to the event subscription.

enabledboolean required

Indicates if we should notify you when the event occurs. The value is one of the following:

  • true - We notify you when the event occurs.
  • false - We don't notify you when the event occurs.
status'registered' | 'suspended' | 'failed'

Status of the subscription. We return one of the following values:

  • registered - You have set up the subscription, and we will notify you when an event occurs.
  • suspended - We have deactivated the event subscription, and we won't notify you when an event occurs.
  • failed - We couldn't contact your URI endpoint. We email the supportEmailAddress.
eventTypesstring[] required

Array of events that you want to subscribe to. For a list of events, go to Events List.

metadataEventSubscriptionMetadata

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id retrieve removed and replaced with eventSubscriptions_retrieve