Automatizimet
Email-e dhe hapa që ekzekutohen vetë për çdo kontakt, dhe ngjarjet që i nisin.
Veglat e automatizimeve
| Vegla | Çfarë bën |
|---|---|
| listAutomations | Automatizimet e hapësirës së punës, nga i ndryshuari më së fundi, me statusin e tyre, çfarë e nis secilin dhe sa kontakte janë në të. |
| getAutomation | Një automatizim i plotë: statusi, cilësimet dhe shifrat e tij, çfarë nuk shkon me skicën e tij, dhe përkufizimi i skicës si JSON. includePublished shton versionin që po ekzekutohet. |
| listAutomationStarters | Automatizimet e gatshme nga të cilat mund të fillojë një i ri, secili me përkufizimin e vet. |
| createAutomation | Krijoni një skicë nga një pikë nisjeje, nga një përkufizim i shkruar si JSON, ose bosh, me çfarëdo cilësimesh. Asgjë nuk ekzekutohet derisa të publikohet. |
| updateAutomation | Ndryshoni emrin dhe cilësimet e një automatizimi, të cilat zbatohen menjëherë, ose zëvendësoni përkufizimin e skicës së tij. Një automatizim aktiv vazhdon të ekzekutojë versionin e tij të publikuar. |
| deleteAutomation | Fshini përgjithmonë një automatizim, me versionet, regjistrimet dhe shifrat e tij. Kontaktet në të ndalen menjëherë. |
| publishAutomation | Bëjeni skicën versionin që ekzekutohet dhe aktivizoni automatizimin. Një skicë e paplotë refuzohet me çdo problem që e bllokon. Kërkon edhe emails:send. |
| pauseAutomation | Ndaloni një automatizim aktiv. Askush i ri nuk hyn, dhe të gjithë që janë në të qëndrojnë aty ku janë. |
| resumeAutomation | Riaktivizoni një automatizim të pezulluar me versionin që po ekzekutonte. Kërkon edhe emails:send. |
| archiveAutomation | Tërhiqni përgjithmonë një automatizim dhe ruani historikun e tij. Të gjithë që janë në të dalin. |
| duplicateAutomation | Kopjoni një automatizim në një skicë të re, pa versionet, kontaktet dhe shifrat e tij. |
| sendAutomationTest | Dërgoni emailin e një hapi të skicës te vetja ose te një adresë. Kërkon edhe emails:send. |
| listAutomationVersions | Versionet e publikuara, më i riu i pari, dhe cili po ekzekutohet. includeDefinitions shton çdo përkufizim. |
| restoreAutomationVersion | Kopjoni një version të mëparshëm sërish në skicë. Asgjë që po ekzekutohet nuk ndryshon deri në publikimin tjetër. |
| getAutomationStats | Kontaktet që hynë, që janë në të tani, që përfunduan dhe që dolën, dhe email-et e dërguara, të dorëzuara, të hapura dhe të klikuara gjatë një periudhe, gjithsej dhe për çdo hap. |
| listAutomationEnrollments | Kontaktet që janë ose kanë qenë në një automatizim, një faqe në një herë, me hapin ku ndodhet secili dhe si përfundoi. Filtroni sipas statusit, hapit ose një pjese të adresës. |
| getAutomationEnrollment | Rruga e një kontakti nëpër një automatizim: çfarë bëri çdo hap për të, më i vjetri i pari. |
| enrollInAutomation | Futni një kontakt në një automatizim aktiv te hapi i tij i parë, pavarësisht se çfarë e nis zakonisht. |
| removeFromAutomation | Nxirrni menjëherë një kontakt nga një automatizim. |
| sendContactEvent | Regjistroni se një kontakti i ndodhi diçka. Kjo nis automatizimet aktive, nisësi i të cilave e emërton ngjarjen, dhe u jep fund pritjeve që po e prisnin. |
| sendContactEvents | Regjistroni deri në 100 ngjarje me një thirrje. Dështimi i njërës nuk i ndal të tjerat. |
| listContactEventNames | Emrat e ngjarjeve që hapësira e punës ka regjistruar në 90 ditët e fundit. |
| listContactEvents | Ngjarjet e regjistruara për një kontakt, më të rejat në krye, një faqe në një herë. |
Leximi kërkon automations:read dhe çdo ndryshim kërkon automations:write. Publikimi, rifillimi dhe dërgimi i një prove kërkojnë edhe emails:send, sepse automatizimi atëherë dërgon postë në emër të atij që e publikoi. Dërgimi i një ngjarjeje kërkon contacts:write, leximi i ngjarjeve të një kontakti kërkon contacts:read, dhe listContactEventNames kërkon automations:read. Një klient që vepron për një anëtar sheh vetëm automatizimet që krijoi ai anëtar dhe kontaktet që shtoi ai anëtar.
Disa mjete në këtë server bëjnë një ndryshim që REST API e mbron me kod verifikimi, dhe kërkojnë të njëjtin kod. Derisa klienti të ketë verifikuar një kod në 60 minutat e fundit, ose personi të ketë zgjedhur Lejo ndryshimet për 60 minuta për të te Llogaria → Aplikacionet e lidhura, një mjet i tillë përgjigjet me një rezultat që nis me Refused (step_up_required): dhe nuk ndryshon asgjë. emptyAudience nuk kërkon kurrë kod. Faqja Autentikimi e API-t rendit çdo mjet që kërkon kod, dhe tregon si kërkohet dhe verifikohet një kod.
Veglat zbatojnë të njëjtat rregulla dhe refuzime si REST API, dhe faqet /automations dhe /events të referencës së API-së përshkruajnë çdo fushë. Një përkufizim jepet i plotë si JSON: lexojeni me getAutomation, ndryshojeni dhe kthejani të gjithin updateAutomation.
Referencë
listAutomationsgetAutomationlistAutomationStarterscreateAutomationupdateAutomationdeleteAutomationpublishAutomationpauseAutomationresumeAutomationarchiveAutomationduplicateAutomationsendAutomationTestlistAutomationVersionsrestoreAutomationVersiongetAutomationStatslistAutomationEnrollmentsgetAutomationEnrollmentenrollInAutomationremoveFromAutomationsendContactEventsendContactEventslistContactEventNameslistContactEvents
listAutomations
List the automations in this workspace, the most recently changed first: name, id, status (draft, live, paused or archived), what starts each one, its steps and how many contacts are in it now, completed it or left early. Use it to find an automation by name before reading or changing it. One page at a time: when more follow, the last line gives a cursor to pass back.
Hyrjet
statusstring- Një nga
"draft""live""paused""archived" limitinteger- Të paktën 1Më së shumti 100
cursorstring- Nga 1 deri në 64 karaktere
E disponueshme edhe në
- API
GET /automations- TypeScript
automations.list()automations.listAll()automations.iterate()- Python
automations.list()automations.list_all()automations.iterate()- Ruby
automations.listautomations.list_allautomations.iterate- PHP
automations->listautomations->listAllautomations->iterate- Go
Automations.ListAutomations.ListAllAutomations.Iterate- Java
automations().listautomations().listAllautomations().iterate- C#
Automations.ListAsyncAutomations.ListAllAsyncAutomations.IterateAsync
getAutomation
Read one automation: its status, settings, numbers, what is wrong with its draft, and the draft definition (trigger and steps) as JSON, to change and pass back to updateAutomation. includePublished adds the definition of the version that is running, which differs from the draft while there are unpublished changes.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktereincludePublishedboolean- Parazgjedhja
false
E disponueshme edhe në
listAutomationStarters
The ready-made automations a new one can begin from, such as a welcome series or a birthday note: slug, name, what each is for and its definition as JSON. Pass a slug to createAutomation as starter. A starter leaves the audience, the templates and the from address empty to fill in.
Hyrjet
Nuk merr asnjë hyrje.
E disponueshme edhe në
createAutomation
Create an automation as a draft: from a starter (listAutomationStarters names them), from a definition written out as JSON, or empty. Nothing runs until publishAutomation. The answer lists what the draft still needs before it can be published, such as a template or a from address for each email. Find audiences with listAudiences, templates with listTemplates and forms with listForms.
Hyrjet
namestringE detyrueshmeA short name for the automation. Contacts never see it.
Nga 1 deri në 120 karakteredescriptionstringOne line about what it is for.
Deri në 500 karakterestarterstring- Nga 1 deri në 64 karaktere
definitionRecord<string, any> | stringThe trigger and steps as JSON: {"trigger": {...}, "entry": "<key of the first step>", "steps": [...]}. Triggers: {"kind": "audience_joined", "audienceId", "includeImported": false}, {"kind": "form_submitted", "formId"}, {"kind": "event", "eventName", "filters": []}, {"kind": "date", "field": "birthday" or "joined", "audienceId", "offsetDays": 0} and {"kind": "manual"}. Every step has a unique key of 3 to 24 lowercase letters and digits starting with a letter, and points at the next step by key in next, or null to end the path. Steps: {"kind": "send_email", "key", "next", "templateId", "templateVersion": null, "from": {"email", "name"}, "replyTo": null, "subject": null, "props": {}}, {"kind": "wait", "key", "next", "wait": {"mode": "duration", "amount": 3, "unit": "days"}}, {"kind": "branch", "key", "condition": {"kind": "email_clicked", "stepKey"}, "yes", "no"}, {"kind": "add_to_audience" or "remove_from_audience", "key", "next", "audienceId"}, {"kind": "update_field", "key", "next", "field", "value": {"source": "static", "value"}}, {"kind": "webhook", "key", "next", "endpointId"} and {"kind": "exit", "key"}. A wait can also be {"mode": "until", "weekdays": [1], "hour": 9, "minute": 0} or {"mode": "event", "eventName", "timeout": {"amount": 7, "unit": "days"}}. Conditions: email_opened and email_clicked with stepKey, in_audience with audienceId, field with field, operator and value, and event with eventName and withinDays. A props value is {"source": "static", "value"}, {"source": "contact", "field"} or {"source": "event", "path"}. Paths never join or loop. getAutomation shows a saved definition in this shape, and listAutomationStarters has ready-made ones.
settingsRecord<string, any> | stringHow it runs, as JSON with any of: timezone (an IANA zone such as Europe/London), sendWindow ({"days": [1, 2, 3, 4, 5], "startMinute": 540, "endMinute": 1020} or null for any time), reentryDays (days after finishing before a contact may enter again, or null for once only), exitOnLeave (true takes a contact out when they leave the audience that started it) and listAudienceId (the audience unsubscribes are recorded in).
E disponueshme edhe në
updateAutomation
Change an automation. Its name, description and settings apply at once. definition replaces the whole draft, so start from getAutomation, change the JSON and pass all of it back. A live automation keeps running its published version until publishAutomation, and contacts already in it stay on the version they entered on. Pass only what changes.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karakterenamestring- Nga 1 deri në 120 karaktere
descriptionstring- Mund të jetë nullDeri në 500 karaktere
definitionRecord<string, any> | stringThe trigger and steps as JSON: {"trigger": {...}, "entry": "<key of the first step>", "steps": [...]}. Triggers: {"kind": "audience_joined", "audienceId", "includeImported": false}, {"kind": "form_submitted", "formId"}, {"kind": "event", "eventName", "filters": []}, {"kind": "date", "field": "birthday" or "joined", "audienceId", "offsetDays": 0} and {"kind": "manual"}. Every step has a unique key of 3 to 24 lowercase letters and digits starting with a letter, and points at the next step by key in next, or null to end the path. Steps: {"kind": "send_email", "key", "next", "templateId", "templateVersion": null, "from": {"email", "name"}, "replyTo": null, "subject": null, "props": {}}, {"kind": "wait", "key", "next", "wait": {"mode": "duration", "amount": 3, "unit": "days"}}, {"kind": "branch", "key", "condition": {"kind": "email_clicked", "stepKey"}, "yes", "no"}, {"kind": "add_to_audience" or "remove_from_audience", "key", "next", "audienceId"}, {"kind": "update_field", "key", "next", "field", "value": {"source": "static", "value"}}, {"kind": "webhook", "key", "next", "endpointId"} and {"kind": "exit", "key"}. A wait can also be {"mode": "until", "weekdays": [1], "hour": 9, "minute": 0} or {"mode": "event", "eventName", "timeout": {"amount": 7, "unit": "days"}}. Conditions: email_opened and email_clicked with stepKey, in_audience with audienceId, field with field, operator and value, and event with eventName and withinDays. A props value is {"source": "static", "value"}, {"source": "contact", "field"} or {"source": "event", "path"}. Paths never join or loop. getAutomation shows a saved definition in this shape, and listAutomationStarters has ready-made ones.
settingsRecord<string, any> | stringHow it runs, as JSON with any of: timezone (an IANA zone such as Europe/London), sendWindow ({"days": [1, 2, 3, 4, 5], "startMinute": 540, "endMinute": 1020} or null for any time), reentryDays (days after finishing before a contact may enter again, or null for once only), exitOnLeave (true takes a contact out when they leave the audience that started it) and listAudienceId (the audience unsubscribes are recorded in).
expectedUpdatedAtstringThe Updated time getAutomation gave. When somebody saved the automation since, the change is refused instead of written over theirs.
Formatidate-time
E disponueshme edhe në
deleteAutomation
Delete an automation for good, with its versions, its enrollments and its numbers. Contacts in it stop at once. The emails it already sent stay. It cannot be undone: to retire one and keep its history, use archiveAutomation.
- Kërkon një kod verifikimi
DELETE /automations/{id}
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktere
E disponueshme edhe në
publishAutomation
Publish an automation: its draft becomes the version that runs and it goes live, so its trigger starts putting contacts in and its emails start going out. Use it for a first publish and to put later changes to work. The draft has to be complete, and a refusal lists every problem that blocks it. Contacts already in it stay on the version they entered on.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktere
E disponueshme edhe në
pauseAutomation
Pause a live automation. Nobody new enters, and everyone in it stays where they are and moves on when it is resumed with resumeAutomation.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktere
E disponueshme edhe në
resumeAutomation
Turn a paused automation back on with the version it was running, without publishing the draft. Contacts that were held move on and its emails go out again. One that was paused because something it needs went away stays paused until that is fixed, and the refusal says what.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktere
E disponueshme edhe në
archiveAutomation
Retire an automation for good and keep its history. Everyone in it leaves, nobody enters again and it can no longer be changed, published or resumed. Its versions, enrollments and numbers stay readable. To stop one for a while, use pauseAutomation.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktere
E disponueshme edhe në
duplicateAutomation
Copy an automation into a new draft with "(copy)" after its name: the same draft definition and settings, and none of its versions, contacts or numbers.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktere
E disponueshme edhe në
sendAutomationTest
Send the email of one step of the draft to one address, to read it before publishing. It goes to the user's own account address unless to names another. Contact values come from a sample contact, the subject starts with [Test], and nobody is enrolled. It counts toward the monthly sends.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karakterestepKeystringE detyrueshmeThe key of the email step, from the definition getAutomation returns.
Nga 1 deri në 64 karakteretostringWhere the test goes, when not to the user themselves.
Deri në 320 karaktereFormatiemail
E disponueshme edhe në
listAutomationVersions
The published versions of an automation, the newest first: number, when it was published and whether it is the one running. includeDefinitions adds each definition as JSON. restoreAutomationVersion copies one back into the draft.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktereincludeDefinitionsboolean- Parazgjedhja
false
E disponueshme edhe në
restoreAutomationVersion
Copy the definition of an earlier version back into the draft, replacing what the draft holds. Nothing that is running changes until publishAutomation.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktereversionintegerE detyrueshmeThe version number, from listAutomationVersions.
Të paktën 1
E disponueshme edhe në
getAutomationStats
How one automation did over a window, 30 days by default: contacts that entered, are in it now, completed it or left early, emails sent, delivered, opened, clicked, bounced and marked as spam, and unsubscribes, in total and for each step. Opens are a floor, because many mail apps hide them. includeDaily adds a line for each day.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karakteresincestringWhere the window starts, as an ISO 8601 instant.
Formatidate-timeuntilstringWhere the window ends, as an ISO 8601 instant. Left out, now.
Formatidate-timeincludeDailyboolean- Parazgjedhja
false
E disponueshme edhe në
listAutomationEnrollments
The contacts that are in an automation or have been, the most recent entry first: which step each is at, what they are waiting for, what holds a step that is due, when they move next and how it ended. Narrow it by status, by step or by a piece of the address or name. One page at a time: when more follow, the last line gives a cursor.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karakterestatusstring- Një nga
"active""completed""exited" stepKeystring- Nga 1 deri në 64 karaktere
qstring- Deri në 200 karaktere
limitinteger- Të paktën 1Më së shumti 200
cursorstring- Nga 1 deri në 64 karaktere
E disponueshme edhe në
- API
GET /automations/{id}/enrollments- TypeScript
automations.listEnrollments()automations.listAllEnrollments()automations.iterateEnrollments()- Python
automations.list_enrollments()automations.list_all_enrollments()automations.iterate_enrollments()- Ruby
automations.list_enrollmentsautomations.list_all_enrollmentsautomations.iterate_enrollments- PHP
automations->listEnrollmentsautomations->listAllEnrollmentsautomations->iterateEnrollments- Go
Automations.ListEnrollmentsAutomations.ListAllEnrollmentsAutomations.IterateEnrollments- Java
automations().listEnrollmentsautomations().listAllEnrollmentsautomations().iterateEnrollments- C#
Automations.ListEnrollmentsAsyncAutomations.ListAllEnrollmentsAsyncAutomations.IterateEnrollmentsAsync
getAutomationEnrollment
One contact's way through an automation: where they are, and what each step did for them, oldest first, such as an email sent, a wait, a yes or no at a branch, or why a step was skipped or failed.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktereenrollmentIdstringE detyrueshmeThe enrollment, by id (aen_...), from listAutomationEnrollments.
Nga 1 deri në 64 karaktere
E disponueshme edhe në
enrollInAutomation
Put one contact into a live automation at its first step, whatever starts it normally, so its emails start going to them. The contact has to exist already. A contact is in an automation once at a time, and an address that is suppressed or unsubscribed is refused.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktereemailstringE detyrueshmeThe contact to enroll, by email address.
Deri në 320 karaktereFormatiemaildataRecord<string, any>Values the steps read wherever a value comes from the event, such as an order number. At most 50 keys and 4 KB of JSON.
E disponueshme edhe në
removeFromAutomation
Take one contact out of an automation at once, by the id of their enrollment from listAutomationEnrollments. They get nothing more from it, and stay in the contacts and in their audiences.
Hyrjet
idstringE detyrueshmeThe automation, by id (aut_...). listAutomations finds it by name.
Nga 1 deri në 64 karaktereenrollmentIdstringE detyrueshmeThe enrollment, by id (aen_...), from listAutomationEnrollments.
Nga 1 deri në 64 karaktere
E disponueshme edhe në
sendContactEvent
Record that something happened to one contact, such as order.placed or trial.started. Every live automation that starts on that event name takes the contact in, so its emails start going to them, and a wait step holding out for the name moves on. The answer says which automations it started. Events are kept for 90 days.
Hyrjet
namestringE detyrueshmeWhat happened, such as order.placed: letters, digits, dots, colons, dashes and underscores. Names are matched exactly, case included.
Nga 1 deri në 100 karaktereemailstringE detyrueshmeThe contact the event is about, by email address.
Deri në 320 karaktereFormatiemailpropertiesRecord<string, any>Details of the event as a JSON object, at most 50 keys and 4 KB. An event trigger can filter on them and steps can use them.
occurredAtstringWhen it happened, as an ISO 8601 instant. Left out, it is now. Not in the future, and at most 90 days ago.
Formatidate-timecreateContactbooleantrue adds the address to the contacts when nobody has it yet.
contactNamestringThe name to give a contact that createContact adds.
Deri në 200 karaktere
sendContactEvents
Record up to 100 events in one call, each handled as sendContactEvent handles one, in order. One event failing does not stop the rest: the answer says which were recorded, what each started, and why any was not.
Hyrjet
eventsobject[]E detyrueshme- Nga 1 deri në 100 elemente
namestringE detyrueshmeWhat happened, such as order.placed: letters, digits, dots, colons, dashes and underscores. Names are matched exactly, case included.
Nga 1 deri në 100 karaktereemailstringE detyrueshmeThe contact the event is about, by email address.
Deri në 320 karaktereFormatiemailpropertiesRecord<string, any>Details of the event as a JSON object, at most 50 keys and 4 KB. An event trigger can filter on them and steps can use them.
occurredAtstringWhen it happened, as an ISO 8601 instant. Left out, it is now. Not in the future, and at most 90 days ago.
Formatidate-timecreateContactbooleantrue adds the address to the contacts when nobody has it yet.
contactNamestringThe name to give a contact that createContact adds.
Deri në 200 karaktere
listContactEventNames
The names of the events this workspace has recorded in the last 90 days, to choose the event that starts an automation or that a wait step holds out for.
Hyrjet
Nuk merr asnjë hyrje.
E disponueshme edhe në
listContactEvents
The events recorded for one contact in the last 90 days, the most recent first: name, when it happened and its properties. Narrow it to one event name. One page at a time: when more follow, the last line gives a cursor.
Hyrjet
emailstringE detyrueshmeThe contact the event is about, by email address.
Nga 3 deri në 320 karakterenamestring- Nga 1 deri në 100 karaktere
limitinteger- Të paktën 1Më së shumti 200
cursorstring- Nga 1 deri në 64 karaktere
E disponueshme edhe në
- API
GET /contacts/{email}/events- TypeScript
contacts.listEvents()contacts.listAllEvents()contacts.iterateEvents()- Python
contacts.list_events()contacts.list_all_events()contacts.iterate_events()- Ruby
contacts.list_eventscontacts.list_all_eventscontacts.iterate_events- PHP
contacts->listEventscontacts->listAllEventscontacts->iterateEvents- Go
Contacts.ListEventsContacts.ListAllEventsContacts.IterateEvents- Java
contacts().listEventscontacts().listAllEventscontacts().iterateEvents- C#
Contacts.ListEventsAsyncContacts.ListAllEventsAsyncContacts.IterateEventsAsync