Schema

Webhook

An endpoint the account's events are delivered to

Fields

  • idstring (uuid)
  • endpointstring (uri)
  • descriptionstring, nullable
  • webhook_eventsarray of object
    The events it is subscribed to
  • webhook_events[].idstring (uuid)
  • webhook_events[].namestring
  • healthobject
    Deliveries per state (in the list only)
  • health.totalinteger
  • health.succeededinteger
  • health.failedinteger
  • health.pendinginteger
  • health.lastAtstring (date-time), nullable
  • createdAtstring (date-time)
  • updatedAtstring (date-time)
Example
{
  "id": "3c0e8f8a-0000-4000-8000-000000000001",
  "endpoint": "https://boutique.example/wp-json/printags/v1/webhook",
  "description": "WooCommerce",
  "webhook_events": [
    {
      "name": "order.shipped"
    }
  ]
}