Ordexs API v1 Get an API key

Webhook event

ping

A test event is requestedSubscribe with events

Sent when a test event is requested. data.object is the WebhookEndpoint as the API returns it. Only ever sent by POST /v1/webhook_endpoints/{id}/test.

data.object

The WebhookEndpoint exactly as retrieve a webhook endpoint returns it, frozen when the change was saved.

  • idstring

    starts with we_

  • objectstring

    always "webhook_endpoint"

  • urlstring

    uri

  • descriptionstring or null
  • eventsarray of strings
  • statusstring

    auto_disabled: every delivery failed for 3 days, so Ordexs stopped sending. Set status: enabled to resume.

    One of enabled, disabled, auto_disabled

  • disabled_reasonstring or null
  • failing_sincestring or null

    When deliveries started failing without a success since.

    ISO 8601 date-time, UTC

  • livemodeboolean
  • secretstring

    Only in the response to create and rotate_secret.

  • created_atstring

    ISO 8601 date-time, UTC

  • updated_atstring

    ISO 8601 date-time, UTC