![]() To mitigate this, you may want to respond immediately with a 2xx HTTP status code, and then perform your complex logic afterwards. If you have to do a bunch of complex logic with the event data, or need to make network requests, it’s possible that the delivery attempt will time-out before we receive a 2xx HTTP status code. We set aggressive time-outs for webhook deliveries. The webhook deliveries endpoint has all the information you need to check how many times we’ve attempted to deliver an event, what the response received was, the status code, and other relevant information. In most cases however, this should be close to instantaneous. We will also attempt to deliver webhooks within 30 minutes from when the event was created. We will attempt to send event deliveries in order, however that is not a guarantee. Webhooks cannot manually be retried, however you can make a query to the events endpoint to reconcile data in case of any missed events. We will attempt to deliver your webhooks up to 6 times with exponential back off. A successful response could look something like this: This is a security measure to ensure that you own the url in question and it hasn't been hijacked. Your endpoint's body must also respond with your challenge token (available in the API Dashboard). Any response codes outside of this range will tell us that the webhook has not been received and will be treated as a failure. To acknowledge that you received a webhook notification, your endpoint needs to respond with either a 200 or 201 HTTP status code. For this to work, your server needs to be setup to support HTTPS with a valid certificate. We will validate that your connection is secure and HIPAA compliant before sending any webhook data. This should be a dedicated URL on your server that is setup to receive webhook notifications.Īll urls need to use HTTPS. For each environment that you have setup, you can enter a URL to receive events. Webhooks are configured through the API Dashboard. Note that we only send events to a single endpoint per environment. Once the event is created, Fullscript will send out a payload with the event data via an HTTP POST request to the webhook url that you defined in your account. It includes the event's type (ex: treatment_plan.created) and any relevant data to that event. This Event contains all the relevant information about what just happened. ![]() When the event occurs-say a treatment plan is created, a patient is updated, or a clinic key is revoked, etc.-Fullscript creates an Event. You can register a single webhook URL through the API Dashboard and subscribe to multiple event types. Let’s say one of your clinics updates a patient or creates a treatment plan webhooks allow you to know about those events and take action if needed. You can subscribe to events and be notified when they happen. Webhooks allow your application to stay informed with what’s happening on Fullscript.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |