Webhookien vastaanottaminen työnkulun päättyessä
Ilmoitus järjestelmiisi, kun työnkulun suoritus päättyy, epäonnistuu tai pysäytetään, ja lähetysten allekirjoituksen tarkistaminen.
Webhookit ilmoittavat järjestelmillesi, kun työnkulun suoritus päättyy. Upsellr lähettää silloin pyynnön valitsemaasi osoitteeseen. Ne sisältyvät Enterprise-pakettiin.
Tapahtumat
| Tapahtuma | Milloin se lähetetään |
|---|---|
| workflow.run.completed | Suoritus päättyy onnistuneesti |
| workflow.run.failed | Suoritus epäonnistuu |
| workflow.run.stopped | Käyttäjä pysäyttää suorituksen |
Jokainen lähetys sisältää suorituksen täydellisen kuvauksen samassa muodossa kuin julkinen API. Välilehti Event catalogue kuvaa tämän muodon.
Endpointin lisääminen
- Avaa tilivalikko ja sitten Manage ja API & webhooks.
- Napsauta välilehdellä Endpoints valintaa Add endpoint.
- Täytä nimi (Name) ja Endpoint URL. Vain julkiset HTTPS-osoitteet hyväksytään: yksityiset verkot ja uudelleenohjaukset estetään.
- Valitse kohdassa Events to receive halutut tapahtumat ja tallenna.
- Kopioi allekirjoitussalaisuus. Se näytetään vain kerran.
Endpointin voi keskeyttää ja ottaa uudelleen käyttöön. Jos kadotat salaisuuden, napsauta Rotate secret ja päivitä vastaanottimesi heti.
Allekirjoituksen tarkistaminen
Jokaisessa lähetyksessä on kaksi otsaketta: X-Upsellr-Timestamp, lähetyksen aikaleima, ja X-Upsellr-Signature muodossa v1= ja sen perässä pienillä kirjaimilla kirjoitettu heksadesimaalinen tiiviste. Tiiviste on HMAC-SHA256, joka lasketaan endpointin salaisuudella aikaleimasta, pisteestä ja pyynnön raa’asta rungosta.
Tarkista allekirjoitus raa’asta rungosta ennen JSONin jäsentämistä. Vertaa allekirjoituksia vakioajassa ja hylkää liian vanhat aikaleimat.
Lähetykset ja uudelleenyritykset
- Tapahtumat lähetetään JSON-muodossa POST-pyynnöllä. Mikä tahansa 2xx-vastaus vahvistaa vastaanoton.
- Epäonnistuessa Upsellr yrittää uudelleen 1 minuutin, 5 minuutin, 30 minuutin, 4 tunnin ja 24 tunnin kuluttua.
- Tapahtuma voi saapua useammin kuin kerran, eikä järjestystä taata: poista kaksoiskappaleet tapahtumatunnisteen perusteella.
Toimitusloki
Välilehti Event deliveries luettelee viimeisten 7 päivän lähetykset tiloineen, yrityksineen ja sisältöineen. Epäonnistuneen lähetyksen kohdalla napsauta Replay failed delivery: sama tapahtuma lähetetään uudelleen samalla tunnisteella.
Hyvä tietää
- Vain omistajat ja ylläpitäjät hallitsevat endpointeja ja lähettävät lähetyksiä uudelleen.
- Endpointin poistaminen peruu sen odottavat lähetykset. Olemassa olevat lokit säilyvät.