Webhooks

Owned by Andrey Veprikov
Last updated: Oct 02, 2023
2 min read

Webhooks allow tracking the statuses of long processes running on the Personaclick side. To start using a webhook, set it up in your account in the "Webhooks" section. The data sent to the webhook depends on a process.

Import Products

Properties used in the request:

NameTypeDescription
statusstringProcess completion status: succes, error.
task_idstring/numberPersonaclick's internal process ID.
item_idstring/numberThe product ID on which the import process failed.
operationstringProcess type. The "import_products" in this case.


Examples:

## success 
{
    "status": "success",
    "task_id": "123456",
    "operation": "import_products"
}

## error
{
    "status": "error",
    "message": "Product ID 100500 doesn't have a picture link.",
    "item_id": "100500",
    "operation": "import_products"
}


Import Audience

Properties used in the request:

NameTypeDescription
statusstringProcess completion status: succes, error.
task_idstring/numberPersonaclick's internal process ID.
segment_idstring/numberThe segment ID on which the import process failed.
operationstringProcess type. The "import_segment" in this case.


Examples:

## success 
{
    "status": "success",
    "segment_id": "100500",
    "task_id": "12345",
    "operation": "import_segment"
}

## error
{
    "status": "error",
    "message": "At least one ID must be in the request",
    "segment_id": "100500",
    "task_id": "12345",
    "operation": "import_segment"
}


Dynamic Segment Calculation

Properties used in the request:

NameTypeDescription
statusstringProcess completion status: succes, failed.
segment_idstring/numberThe segment ID in the process.
operationstringProcess type. The "segment_recalculated_dynamic" in this case.


Examples:

## success 
{
    "status": "success",
    "segment_id": "100500",
    "operation": "segment_recalculated_dynamic"
}

## failed
{
    "status": "failed",
    "segment_id": "100500",
    "operation": "segment_recalculated_dynamic"
}


RFM Segment Calculation

Properties used in the request:

NameTypeDescription
statusstringProcess completion status: succes, failed.
segment_idstring/numberThe segment ID in the process.
operationstringProcess type. The "segment_recalculated_rfm" in this case.


Examples:

## success 
{
    "status": "success",
    "segment_id": "100500",
    "operation": "segment_recalculated_rfm"
}

## failed
{
    "status": "failed",
    "segment_id": "100500",
    "operation": "segment_recalculated_rfm"
}


Sending Bulk Campaign

Properties used in the request:

NameTypeDescription
statusstringProcess completion status: succes, failed, spam.
bulk_campaign_idstring/numberThe campaign ID in the process.
operationstringProcess type. The "segment_recalculated_rfm" in this case.


Examples:

## success 
{
    "status": "success",
    "bulk_campaign_id": "100500",
    "operation": "bulk_campaign"
}

## failed
{
    "status": "failed",
    "bulk_campaign_id": "100500",
    "operation": "bulk_campaign"
}

## spam
{
    "status": "spam",
    "bulk_campaign_id": "100500",
    "operation": "bulk_campaign"
}

Page Navigation



Related Pages

Copyright 2018-2024 PersonaClick