A webhook: where events are sent, which ones, and how it’s going. Never its secret.
idstring (uuid)requiredkindenumrequiredpersonalstoreadminstoreIdstring (uuid) or nullrequiredurlstring (uri)requiredWhere deliveries are POSTed.
descriptionstring or nullrequiredeventsarray of stringrequiredThe event types it’s sent.
statusenumrequiredactive: deliveries are sent. disabled: turned off by someone, or after failing every delivery for 3 days (disabledReason says which).
activedisableddisabledAtstring (date-time) or nullrequireddisabledReasonstring or nullrequiredsecretHintstringrequiredThe signing secret’s last characters: whsec_…AbCd. The whole secret is shown only once.
previousSecretExpiresAtstring (date-time) or nullrequiredcreatedByobject or nullrequiredWho made it (a store or admin webhook works as them).
idstring (uuid)requiredlabelstring or nullrequiredcreatedAtstring (date-time)requiredupdatedAtstring (date-time)requiredhealthobjectrequiredHow deliveries are going. 20 failures in a row over 3 days turn the webhook off.
failureStreakintegerrequiredFailed attempts in a row (test events aren’t counted).
failingSincestring (date-time) or nullrequiredlastSuccessAtstring (date-time) or nullrequiredlastFailureAtstring (date-time) or nullrequired