Creates a WebhookEndpoint resource.

• apikey

  string

  header

  required

  Value for the apikey header parameter.

The new WebhookEndpoint resource

• audience

  enum<string>

  Which side of the organization receives the events: publisher (orders of its media) or client (orders it placed).

  One of:

  publisher

  client
  Default:

  publisher
• url

  string<uri>

  required
• enabled

  boolean
  Default:

  true

WebhookEndpoint resource created

• @context

  one of
  Show fields
• @id

  string

  required
• @type

  string

  required
• id

  string<uuid> | null
• audience

  enum<string>

  Which side of the organization receives the events: publisher (orders of its media) or client (orders it placed).

  One of:

  publisher

  client
  Default:

  publisher
• url

  string<uri>

  required
• enabled

  boolean
  Default:

  true
• verifiedAt

  string<date-time> | null

  When the URL last answered a ping with pong.

• status

  enum<string>

  active: the last ping or event went through; failing: the last ping failed or an event failed after every retry; disabled: turned off.

  One of:

  active

  failing

  disabled
  Default:

  active
• lastDeliveredAt

  string<date-time> | null
• lastFailedAt

  string<date-time> | null
• lastError

  string | null

  Why the last ping or event failed; empty after the next success.

• createdAt

  string<date-time> | null
• secret

  string | null

  The signing secret; returned on creation and rotation only, never again.