Ordexs API v1 Get an API key

Webhooks

Update a webhook endpoint

PATCHhttps://api.ordexs.com/v1/webhook_endpoints/{webhook_endpoint_id}

Change the URL, the events or the description, or set status to disabled / enabled. Enabling an endpoint that was turned off after failing for 3 days starts it fresh.

Path parameters

  • webhook_endpoint_idstringRequired

    starts with we_

Body

  • urlstring

    up to 2048 characters

  • eventsarray of WebhookEventTypes

    One of *, order.created, order.updated, order.status_changed, order.cancelled, order.needs_review, order.note_added, product.created, product.updated, product.deleted, inventory.updated, customer.created, customer.updated, shipment.created, shipment.updated, abandoned_checkout.created, abandoned_checkout.updated, review.created, bulk_job.completed
    up to 64 items · at least 1 item

  • descriptionstring or null

    up to 200 characters

  • statusstring

    One of enabled, disabled

Returns

200 OK · The endpoint. WebhookEndpoint

  • 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

Errors

Every error has the same shape. This endpoint can answer with: