Event Types and Response Codes (Reference)

Article Details

Summary

After you turn on webhooks, Gingr sends an HTTP(S) request to your webhook URL when one of these events happens. The request has the event data in JSON format. This article lists the event types, how to check the signature, and the response codes you can send back.

Event Types

Technical Event Name Human Readable Event Name Event Description
check_in Reservation checked in Triggers when a reservation is checked in.
check_out Reservation checked out Triggers when a reservation is checked out.
checking_in Reservation checking in Triggers when a user shows intent to check in a reservation. This can happen when a pet parent texts HERE to Gingr, or when an employee clicks the check-in button on the dashboard.
checking_out Reservation checking out Triggers when a reservation is added to the shopping cart.
email_sent Email sent Triggers when Gingr sends a system-generated email.
owner_created Owner created Triggers when a new owner record is created, either in the customer portal or by an employee in the app.
owner_edited Owner edited Triggers when an owner record is updated, either in the customer portal or by an employee in the app.
animal_created Animal created Triggers when a new animal record is created, either in the customer portal or by an employee in the app.
animal_edited Animal edited Triggers when an animal record is updated, either in the customer portal or by an employee in the app.
incident_created Incident created Triggers when an employee creates a new incident for an animal in the app.
incident_edited Incident edited Triggers when an employee updates an incident for an animal in the app.
lead_created Lead created Triggers when a pet parent fills out a lead form, either in the Gingr embeddable lead capture form or in the Gingr customer portal.

HMAC Signature Verification

Each request has a signature property. This is the output of a SHA256 HMAC function. The message is "$webhook_type$entity_id$entity_type" (three variables joined together), and the key is the Webhook Signature Key you set in Gingr. Check the signature when you get a request. This shows the request came from Gingr and not from an imposter.

Response Codes

When you receive a webhook, you can tell Gingr whether you processed it. Use these response codes:

Response Code Description Helpful Hint
200 You received and processed the webhook. Gingr does not try to send it again.
403 Your application does not want this event. Gingr does not try to send it again.
Any other response code An error happened. Gingr tries 10 times, and waits longer between each try.

Notice: Our Support Teams cannot answer technical questions about webhook setup beyond what is in our Knowledge Base articles on webhooks. For more help, work with a third-party developer.

Related Articles

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.