Pāriet uz galveno saturu
Tīmekļa āķi (webhooks) ļauj AgencyHandy nekavējoties nosūtīt datus uz jūsu ārējām sistēmām, tiklīdz kaut kas mainās — aptaujāšana nav nepieciešama. Kad konfigurēts notikums tiek aktivizēts (piemēram, pasūtījums tiek atjaunināts vai atbalsta pieprasījums izveidots), AgencyHandy nosūta HTTP POST pieprasījumu ar JSON slodzi uz jūsu norādīto galapunkta URL. Tas ļauj ērti sinhronizēt ārējos rīkus, piemēram, CRM sistēmas, norēķinu sistēmas vai pielāgotas informācijas paneļus, ar jūsu AgencyHandy darbvietu reāllaikā.
Business Pro plāna darbvietas atbalsta līdz 30 000 tīmekļa āķu notikumiem vienā norēķinu periodā. Pirms augstas intensitātes automatizāciju iestatīšanas pārbaudiet sava plāna ierobežojumus.

​
Atbalstītie notikumi

Tīmekļa āķi var abonēt jebkuru šādu notikumu kombināciju:
KategorijaNotikumi
PakalpojumsIzveidots, atjaunināts, dzēsts
PasūtījumsIzveidots, atjaunināts, dzēsts
UzdevumsIzveidots, piešķirts, pabeigts, atjaunināts
RēķinsStatuss mainīts
Klients / LietotājsJauns klients pievienots, klients/lietotājs dzēsts
PriekšlikumsNosūtīts, saņemts, pieņemts, noraidīts
Atbalsta pieprasījumsIzveidots, piešķirts, statuss mainīts
MaksājumsSaņemts, neizdevies
Pakalpojuma pakotneIzveidota, atjaunināta, dzēsta

​
Izveidot tīmekļa āķi

1

Dodieties uz tīmekļa āķu pārvaldību

Kreisajā sānjoslā dodieties uz Integrations → Webhooks Management.
2

Autentificēt savu tokenu

Noklikšķiniet uz pogas Management, lai autentificētu savu tīmekļa āķa tokenu. Šis tokens tiek izmantots, lai parakstītu izejošās slodzes, lai varētu pārbaudīt, ka tās nāk no AgencyHandy.
3

Izveidot jaunu tīmekļa āķi

Noklikšķiniet uz Create New Webhook, lai atvērtu tīmekļa āķa konfigurācijas veidlapu.
4

Ievadiet galapunkta URL

Laukā Endpoint URL ievadiet ārējās sistēmas URL, kurai jāsaņem tīmekļa āķa dati. Tam jābūt publiski pieejamam POST galapunktam.
5

Izvēlieties satura veidu

Izvēlieties JSON kā satura veidu. AgencyHandy visas tīmekļa āķu slodzes nosūta kā application/json.
6

Atlasiet tīmekļa āķa notikumus

Izvēlieties katru notikumu, kuram jāaktivizē šis tīmekļa āķis. Varat atlasīt notikumus no vairākām kategorijām — piemēram, Order: Created un Invoice: Status changed var norādīt uz vienu un to pašu galapunktu.
7

Aktivizēt tīmekļa āķi

Pārslēdziet radio pogu Active. Kad aktīvs, AgencyHandy reāllaikā piegādā slodzes visiem atlasītajiem notikumiem uz jūsu galapunktu.
8

Saglabāt konfigurāciju

Pārskatiet iestatījumus, pēc tam noklikšķiniet uz Save. Tīmekļa āķis parādās sarakstā un nekavējoties sāk piegādāt notikumus.

​
Testēt tīmekļa āķi

Pēc tīmekļa āķa izveidošanas nosūtiet testa slodzi, lai apstiprinātu, ka jūsu galapunkts ir sasniedzams un datus apstrādā pareizi.
1

Atveriet tīmekļa āķi

Tīmekļa āķu pārvaldības sarakstā noklikšķiniet uz tīmekļa āķa, kuru vēlaties testēt.
2

Noklikšķiniet uz Test Event

Tīmekļa āķa detalizācijas lapā noklikšķiniet uz pogas Test Event.
3

Atlasiet testa notikumu

Izvēlieties parauga notikumu no šim tīmekļa āķim konfigurēto notikumu saraksta (piemēram, Order: Created).
4

Nosūtiet testa slodzi

Noklikšķiniet uz Send. AgencyHandy publicē parauga slodzi uz jūsu galapunkta URL.
5

Pārbaudiet rezultātu

Pārbaudiet savu ārējo sistēmu, lai apstiprinātu, ka testa slodze pienāca un tika apstrādāta, kā paredzēts. Atpakaļ AgencyHandy noklikšķiniet uz tīmekļa āķa, lai pārskatītu tā vēsturi — varat redzēt pilnu pieprasījumu, jūsu galapunkta atgriezto atbildi, un atkārtoti piegādāt jebkuru pagātnes notikumu, ja nepieciešams.
Izmantojiet rīku, piemēram, Webhook.site vai RequestBin, kā pagaidu galapunktu iestatīšanas laikā, lai pārbaudītu precīzo slodzes formu pirms reālās sistēmas pievienošanas.

​
Autentificēt tīmekļa āķu slodzes

Katrs izejošais tīmekļa āķa pieprasījums no AgencyHandy ietver paraksta galveni, ko jūsu galapunkts var izmantot, lai pārbaudītu, ka slodze ir autentiska un nav tikusi mainīta.

​
Paraksta galvene

x-ah-sig: <signature>
AgencyHandy pievieno šo galveni katram tīmekļa āķa pieprasījumam. Izvelciet vērtību no ienākošajiem pieprasījumiem un nododiet to verifikācijas galapunktam.

​
Pārbaudīt tīmekļa āķa parakstu

Nosūtiet šādu pieprasījumu, lai apstiprinātu slodzes autentiskumu: 
POST https://api.agencyhandy.com/api/v1/webhooks/verify-signature
Content-Type: application/json
​
webhookId
string
obligāts
Tā tīmekļa āķa ID, kurš saņēma notikumu. Atrodiet to tīmekļa āķa detalizācijas lapā AgencyHandy.
​
signature
string
obligāts
x-ah-sig galvenes vērtība no ienākošā tīmekļa āķa pieprasījuma.
​
secret
string
obligāts
Tīmekļa āķa noslēpums, kas parādīts tīmekļa āķa detalizācijas lapā AgencyHandy.
​
payload
object
obligāts
Neapstrādāts JSON pamatteksts, saņemts no AgencyHandy tīmekļa āķa pieprasījuma.
const url = 'https://api.agencyhandy.com/api/v1/webhooks/verify-signature';

const postData = {
  webhookId: 'your_webhook_id',
  signature: 'your_signature',   // value of x-ah-sig header
  secret: 'your_webhook_secret',
  payload: {},                   // the parsed JSON body from AgencyHandy
};

const response = await fetch(url, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify(postData),
});

const data = await response.json();
console.log(data); // { "verification_status": "SUCCESS" }
Atbildes
​
verification_status
string
SUCCESS ja paraksts ir derīgs. FAILED ja verifikācija neizdodas (HTTP 403).
Success (200)
{
  "verification_status": "SUCCESS"
}
Failure (403)
{
  "type": "PermissionError",
  "status": 403,
  "verification_status": "FAILED"
}
Glabājiet sava tīmekļa āķa noslēpumu konfidenciāli. Regulāri mainiet to un nekavējoties atjauniniet savu verifikācijas loģiku pēc maiņas. Nekad neatklājiet to klienta puses kodā vai publiskās repozitorijās.

​
Svarīgas piezīmes

  • Jūsu galapunkta URL ir jābūt publiski pieejamam HTTPS POST URL.
  • Ja jūsu galapunkts īslaicīgi nav pieejams, pārbaudiet tīmekļa āķa vēstures paneli AgencyHandy — no turienes varat tieši atkārtoti piegādāt jebkuru pagātnes notikumu.
  • Regulāri uzraugiet tīmekļa āķu darbību, lai atklātu neizdevušās piegādes vai nesankcionētas piekļuves mēģinājumus.
  • Tīmekļa āķi, kas atkārtoti neizdodas, var tikt apturēti no AgencyHandy puses — pārskatiet piegādes žurnālus, lai savlaicīgi atklātu problēmas.