Skip to main content

On-Site Messages Integration

Overview

InTarget can trigger on-site messages during campaigns.

When this happens, we will send a POST request to the client’s endpoint with a JSON payload.

Request Format

We will call the URL you provide with the following body:

{
"userId":"123456",
"title":"Limited-time bonus",
"message":"Deposit today and get +20% extra.",
"image":"https://cdn.example.com/promo/bonus-banner.png",
"buttonUrl":"https://example.com/deposit",
"buttonText":"Claim bonus"
}
  • userId — ID of the user who should see the message in your system

  • title — message title defined in InTarget

  • message — message text defined in InTarget

  • image — URL of the image to show with the message. No size restrictions on our side

  • buttonUrl — URL the message button leads to. Can be an absolute URL or a relative path on your site

  • buttonText — label shown on the message button

All keys are always present in the payload — nothing is dropped. If a field isn’t filled in, you get null instead of a value.

buttonUrl and buttonText are independent. One can be null while the other has a value, so handle each on its own when rendering the button.

Integration Requirements

  1. Provide a public HTTPS endpoint (POST, JSON).

  2. Accept the payload above and map it to your internal on-site message logic.

  3. Handle null in image, buttonUrl, and buttonText — skip rendering that element instead of printing an empty block.

  4. Respond with HTTP 200 when the message is received.

Example response:

{ "accepted": true }
Did this answer your question?