> For the complete documentation index, see [llms.txt](https://support.emarketeer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.emarketeer.com/docs/docs_se/referens/apis-developer/custom-signals-api.md).

# Custom Signals API

Den här tutorialen förklarar hur du använder Signals API för att skicka kontakthändelser till eMarketeer.

API-referens: <https://api-doc.emarketeer.com/?urls.primaryName=Engagement>

***

Kontakter i eMarketeer består av tre huvuddelar:

* Kontaktfält
* Engagemang
* Rättslig grund (samtycke)

Engagemang registrerar varje interaktion en kontakt gör med kampanjkomponenter som e-postmeddelanden, formulär och landningssidor. Dessa interaktioner visas i kontaktens tidslinje och kan användas för att sätta lead score, trigga Journeys och mer. De ger en 360-graders bild av vad kontakten har interagerat med över tid.

<div align="left" data-with-frame="true"><img src="https://2555292243-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FicfGEyRadiE4k7sV4O4o%2Fuploads%2Fgit-blob-8f3f9ceed56f65b7966381761fb09498dd260eab%2Fcustom-signals-api-contact-timeline.png?alt=media" alt="Fliken Timeline på kontaktkortet med filtren All, Outbound, Inbound och Signals, grupperad efter datum"></div>

### Custom Signals

Med Custom Signals API kan du skicka kontakthändelser från vilket annat system som helst in i eMarketeer, så länge du har kontaktens e-postadress. Dessa signaler läggs till som tidslinjehändelser på kontakten och kan användas i filter, scoring, Journeys och leadgenerering.

I följande scenario har du ett arkadspel som heter "Space Invaders". Varje gång någon spelar spelet vill du registrera händelsen i eMarketeer. Du kan sedan trigga Journeys baserat på olika kriterier — till exempel skicka ett e-postmeddelande till alla som får över 100 poäng.

<div align="left" data-with-frame="true"><img src="https://2555292243-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FicfGEyRadiE4k7sV4O4o%2Fuploads%2Fgit-blob-baa5f5d8c608de15b25ce2b251479707b6fcba1b%2Fcustom-signals-api-contact-timeline-signals.png?alt=media" alt="Tidslinjen filtrerad på Signals med händelserna Game Played och Inserted Coins"></div>

<div align="left" data-with-frame="true"><img src="https://2555292243-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FicfGEyRadiE4k7sV4O4o%2Fuploads%2Fgit-blob-618c0d263118b6d565bf9569c0eeee109c668c72%2Fcustom-signals-api-signal-details.png?alt=media" alt="Vyn More information för en Game Played-signal med Player Name och Score under Signal data"></div>

### Strukturen för custom signals

För att skicka exemplet ovan som en signal genom API:et skulle du använda denna payload. Parametrarna förklaras nedan.

```
{
  "adapter": "Space Invaders",
  "category": "Game Played",
  "eventData": {
    "Player Name": "Parzival",
    "Reached Level": "8",
    "Score": "10"
  },
    "contact": {
        "firstName": "Tye",
        "lastName": "Sheridan",
        "email": "tye@playerone.com",
        "company": "Oasis"
  },
  "eventTime": "2023-12-13T10:06:42.375Z",
    "consent": {
    "marketing": {
      "allowed": true,
      "text": "I agree to emails"
    }
  }
}
```

En custom signal har följande huvuddelar.

**Adapter**

Toppnivånamnet för signalen. I kontaktfiltret listas det i listan Engagement type när du lägger till ett Engagement-villkor.

<div align="left" data-with-frame="true"><img src="https://2555292243-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FicfGEyRadiE4k7sV4O4o%2Fuploads%2Fgit-blob-bca88401824554f0c64841d93e3bba627cd279c3%2Fcustom-signals-api-filter-engagement-type.png?alt=media" alt="Listan Engagement type i kontaktfiltret där adaptern Space Invaders är markerad med en pil"></div>

Håll antalet distinkta adapternamn till ett minimum, eftersom alla distinkta adapternamn visas i listan Engagement type. En bra praxis är att använda tjänstens namn för de signaler du skickar. En adapter kan sedan skicka flera typer av händelser.

I det här exemplet är adapternamnet "Space Invaders".

**Category**

"Verbet" för signalen. I Space Invaders-exemplet inkluderar möjliga kategorier:

* Game played
* Inserted coins
* Got high score

<div align="left" data-with-frame="true"><img src="https://2555292243-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FicfGEyRadiE4k7sV4O4o%2Fuploads%2Fgit-blob-49b6bac1ec7706c6f2675457b1076de9f1c0ffe5%2Fcustom-signals-api-signals-dialog.png?alt=media" alt="Dialogrutan Signals med signalerna som skickats för adaptern Space Invaders"></div>

I filtret, när du väljer adapternamnet "Space Invaders" som engagemangstyp, klickar du på Signal för att se kategorierna av signaler du har skickat för den adaptern.

**Event data**

Du kan skicka all information du behöver med signalen. I det här fallet bär "Game played"-signalen Player Name, Reached Level och Score. Alla dessa kan användas i kontaktfiltret för att hitta kontakter som spelade spelet och nådde en viss poäng eller nivå.

<div align="left" data-with-frame="true"><img src="https://2555292243-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FicfGEyRadiE4k7sV4O4o%2Fuploads%2Fgit-blob-618c0d263118b6d565bf9569c0eeee109c668c72%2Fcustom-signals-api-signal-details.png?alt=media" alt="Signal data för en Game Played-signal med fälten Player Name och Score"></div>

**Contact data**

Alla signaler måste tilldelas en kontakt. Som minimum behöver du en e-postadress, men du kan skicka vilket standard- eller anpassat fält som helst till kontaktkortet för att skapa eller uppdatera kontakten.

**Consent (valfritt)**

Du kan också skicka rättslig grunddata för marknadsföringsmejl tillsammans med signalen.

**Event Time**

Tidsstämpeln du vill ha för händelsen i tidslinjen. Skicka den som Zulu-tid (UTC).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://support.emarketeer.com/docs/docs_se/referens/apis-developer/custom-signals-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
