Trigger Webhook Event - Lifecycle Processor

Endpoint

POST https://dev-core-ias-rest.telegramd.com/orders/<put-order-id-here>/actions/lifecycleProcessor/triggerWebhook?access_token={{ias.affiliate.accessToken}}

Requirements

The request must include a JSON body.
The webhookId provided must be configured to be interested in (i.e., listen for) the specified eventType.
The eventType must be of category "Order" and have a "Public" level.
The affiliate must have lifecycleProcessorEnabled setting enabled in their development settings.

Request Body Structure

{
   "eventType": "order_submitted",
   "webhookId": "webhook::example_id"
}

Request Body Parameters

Parameter	Type	Required	Description
`eventType`	string	Yes	The type of webhook event to trigger (see supported values below)
`webhookId`	string	Yes	The ID of the webhook configuration that should receive this event

Supported eventType Values

The following event types are supported for the triggerWebhook lifecycle processor action:

affiliate_admin_was_assigned
external_questionnaire_instance_synchronization_attempt
message-from-admin-practitioner-received
new_status_set_to_request
order_created
order_expedited
order_payment_collected
order_product_variation_transitioned
order_submitted
order_updated
patient_communication_answered_call
patient_communication_follow_up_required
patient_communication_text_message_sent
patient_communication_unanswered_call
pharmacy_bundle_fax_sent
visit_type_overridden
visit_type_updated

Example Request

curl -X POST \
  'https://dev-core-ias-rest.telegramd.com/orders/12345/actions/lifecycleProcessor/triggerWebhook?access_token=your_access_token' \
  -H 'Content-Type: application/json' \
  -d '{
    "eventType": "order_submitted",
    "webhookId": "webhook::example_id"
  }'

Response

On success, the endpoint returns the created event object with details about the triggered webhook event.

Notes

This endpoint is only available in development environments.
The endpoint will return a 500 error if used in production.
The webhook must be configured to listen for the specified event type, otherwise the request will fail with an authorization error.