comecerodocs

Send a test event

POST
/event_subscriptions/{event_subscription_id}/test/{event_test_template_id}

Sends one sample event to the subscription's destination now and says whether it got through. The sample data comes from an event test template: a saved example payload for one event type, either one of Comecero's or one made in the dashboard (Developer, Event Subscriptions). The template's event type must match the subscription's event_type (400). The event is signed and shaped like a real one (show and hide apply; expand does not, since the sample is sent as saved), but it is not saved, so it is not in /events and is never retried. It is sent even when the subscription is inactive. No body is needed. Secret and trusted tokens may call it; a limited token may not (403).

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

event_subscription_id*string

The event subscription id.

event_test_template_id*string

The id of the event test template whose sample payload to send.

Response Body

The result of the attempt. A 200 means the attempt was made: read success.

application/json
  1. response

The result of sending one test event.

success?boolean

true when your server answered 2xx. For an email subscription this is true whenever the email was handed to the mail service, even if sending failed later.

error?|

Why the delivery failed, such as the status code and the start of your server's answer. null on success.

event_id?string

The id the test event was sent with. Test events are not saved, so you cannot get it from /events.

event_type?event_type

The kind of event. See the Webhooks section of this reference for when each one fires and what its data holds.

Value in"account:modified""cart:payment_completed""gateway:created""gateway:modified""event_subscription:created""event_subscription:modified""event_subscription:deleted""license_service:low_licenses""invoice:created""invoice:published""invoice:paid""invoice:payment_completed""order:created""order:payment_completed""order:fulfilled""order:licenses_assigned""payment:completed""payment:created_success""payment:created_failure""payment:captured_success""payment:captured_failure""payment:voided""product:created""product:modified""product:deleted""product:low_inventory""refund:created_success""refund:created_failure""refund:deleted""user:created""user:modified""shipment:created""shipment:modified""shipment:deleted""subscription:created""subscription:modified""subscription:cancelled""subscription:cancellation_scheduled""subscription:cancellation_unscheduled""subscription:completed""subscription:converted""subscription_item:added""subscription_item:cancelled""subscription_item:cancellation_scheduled""subscription_item:cancellation_unscheduled""subscription_item:modified""subscription:renewal_success""subscription:renewal_failure"
Example Request
curl -X POST 'https://api.comecero.com/api/v1/event_subscriptions/string/test/string'
Example Response
{  "success": false,  "error": "There was a problem contacting the remote server: HTTP Status Code: 404, Response Content (preview of first 500 characters): Not Found",  "event_id": "1102611204410EVn3Rk8Wd",  "event_type": "order:created"}