Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt
  • subscriptionIdname — The unique identifier for the subscription. This ID can be used to edit or delete the subscription.
  • name — The name for the subscription, specified during the creation of the subscription. The name is unique.
  • url — The URL that the webhook events are sent to.
  • events — A list of the event types that are subscribed to and are sent to the URL. Each item in the list is the name of an event type.
  • enabled — Indicates whether the subscription is enabled. Notifications are only sent to the URL if the subscription is enabledname of the event type. This typically consists of three parts — the entity performing the action, the action, and the version of the event type. The name of the event type can be used to create a new subscription.
  • description — A brief description of what the event type is and when it will be raised.
  • jsonSchema — The schema of the webhook event type. Each event type can have a different schema containing useful information about the event that occurred.