Kit
kitKit is a platform that allows creators to automate tasks and developers to build apps for the Kit App Store.
Acciones disponibles (29)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Subscriber to FormKIT_ADD_SUBSCRIBER_TO_FORMAcciónTool to add a subscriber to a specific form by id. use after confirming form and subscriber ids.
KIT_ADD_SUBSCRIBER_TO_FORMAcciónTool to add a subscriber to a specific form by id. use after confirming form and subscriber ids.
Parámetros de entrada
idintegerObligatorioThe ID of the subscriber to add to the form.
form_idintegerObligatorioThe ID of the form to which the subscriber will be added.
referrerstringThe URL from which the subscriber was referred.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Custom FieldKIT_CREATE_CUSTOM_FIELDAcciónTool to create a new custom field for subscriber data. use when you need to store extra attributes for subscribers.
KIT_CREATE_CUSTOM_FIELDAcciónTool to create a new custom field for subscriber data. use when you need to store extra attributes for subscribers.
Parámetros de entrada
labelstringObligatorioThe display label for the custom field (e.g., 'Favorite Color').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create TagKIT_CREATE_TAGAcciónTool to create a new tag in the account. use when you need a custom label to segment subscribers. use after confirming tag uniqueness to avoid duplicates. example: "create a tag called 'vip' for premium customers."
KIT_CREATE_TAGAcciónTool to create a new tag in the account. use when you need a custom label to segment subscribers. use after confirming tag uniqueness to avoid duplicates. example: "create a tag called 'vip' for premium customers."
Parámetros de entrada
namestringObligatorioName of the tag to be created.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WebhookKIT_CREATE_WEBHOOKAcciónTool to create a new webhook subscription. use when you need subscriber or purchase event notifications.
KIT_CREATE_WEBHOOKAcciónTool to create a new webhook subscription. use when you need subscriber or purchase event notifications.
Parámetros de entrada
eventobjectObligatorioWebhook event configuration.
target_urlstringObligatorioURL to receive webhook POST notifications.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete BroadcastKIT_DELETE_BROADCASTAcciónTool to delete a specific broadcast. use when you need to permanently remove a broadcast by id (after confirming the id). example prompt: "delete broadcast with id 123"
KIT_DELETE_BROADCASTAcciónTool to delete a specific broadcast. use when you need to permanently remove a broadcast by id (after confirming the id). example prompt: "delete broadcast with id 123"
Parámetros de entrada
idintegerObligatorioUnique identifier of the broadcast to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Custom FieldKIT_DELETE_CUSTOM_FIELDAcciónTool to delete a specific custom field. use after confirming the custom field id is correct. deletes the field permanently.
KIT_DELETE_CUSTOM_FIELDAcciónTool to delete a specific custom field. use after confirming the custom field id is correct. deletes the field permanently.
Parámetros de entrada
idintegerObligatorioUnique identifier of the custom field to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SubscriberKIT_DELETE_SUBSCRIBERAcciónTool to delete (unsubscribe) a subscriber by id. use when you need to remove a subscriber from all sequences and forms after confirming the subscriber exists.
KIT_DELETE_SUBSCRIBERAcciónTool to delete (unsubscribe) a subscriber by id. use when you need to remove a subscriber from all sequences and forms after confirming the subscriber exists.
Parámetros de entrada
idintegerObligatorioUnique identifier of the subscriber to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete TagKIT_DELETE_TAGAcciónTool to delete a tag by id. use when you need to remove obsolete or incorrect tags after confirming the tag exists.
KIT_DELETE_TAGAcciónTool to delete a tag by id. use when you need to remove obsolete or incorrect tags after confirming the tag exists.
Parámetros de entrada
idintegerObligatorioUnique identifier of the tag to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete WebhookKIT_DELETE_WEBHOOKAcciónTool to delete a webhook by id. use when you want to permanently remove a webhook after confirming its id.
KIT_DELETE_WEBHOOKAcciónTool to delete a webhook by id. use when you want to permanently remove a webhook after confirming its id.
Parámetros de entrada
idintegerObligatorioUnique identifier of the webhook to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get AccountKIT_GET_ACCOUNTAcciónTool to retrieve current account information. use after validating api key to fetch account id, plan type, primary email, and timezone details.
KIT_GET_ACCOUNTAcciónTool to retrieve current account information. use after validating api key to fetch account id, plan type, primary email, and timezone details.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Account ColorsKIT_GET_ACCOUNT_COLORSAcciónTool to retrieve list of colors associated with the account. use after confirming authentication to fetch account-specific color palette.
KIT_GET_ACCOUNT_COLORSAcciónTool to retrieve list of colors associated with the account. use after confirming authentication to fetch account-specific color palette.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get BroadcastKIT_GET_BROADCASTAcciónTool to retrieve details of a specific broadcast by id. use when you have a valid broadcast id and need its metadata.
KIT_GET_BROADCASTAcciónTool to retrieve details of a specific broadcast by id. use when you have a valid broadcast id and need its metadata.
Parámetros de entrada
idintegerObligatorioUnique identifier of the broadcast to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Broadcast StatsKIT_GET_BROADCAST_STATSAcciónTool to retrieve statistics for a specific broadcast by id. use after a broadcast has been sent to monitor performance.
KIT_GET_BROADCAST_STATSAcciónTool to retrieve statistics for a specific broadcast by id. use after a broadcast has been sent to monitor performance.
Parámetros de entrada
idintegerObligatorioUnique identifier of the broadcast to fetch statistics for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Creator ProfileKIT_GET_CREATOR_PROFILEAcciónTool to retrieve the creator profile information for the account. use when you need creator metadata (bio, avatar, social links) before publishing or customizing content.
KIT_GET_CREATOR_PROFILEAcciónTool to retrieve the creator profile information for the account. use when you need creator metadata (bio, avatar, social links) before publishing or customizing content.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Email StatsKIT_GET_EMAIL_STATSAcciónTool to retrieve email statistics for the account. use after confirming authentication to fetch metrics on emails (sent, opened, clicked) over the last 90 days.
KIT_GET_EMAIL_STATSAcciónTool to retrieve email statistics for the account. use after confirming authentication to fetch metrics on emails (sent, opened, clicked) over the last 90 days.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List BroadcastsKIT_LIST_BROADCASTSAcciónTool to retrieve a paginated list of all broadcasts. use when you need to enumerate or review broadcast summaries with cursor-based pagination.
KIT_LIST_BROADCASTSAcciónTool to retrieve a paginated list of all broadcasts. use when you need to enumerate or review broadcast summaries with cursor-based pagination.
Parámetros de entrada
afterstringCursor for pagination; returns results after the specified cursor.
beforestringCursor for pagination; returns results before the specified cursor.
per_pageintegerNumber of results per page; must be between 1 and 500.
include_total_countstringIf set to 'true', includes the total count of records in the response.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Custom FieldsKIT_LIST_CUSTOM_FIELDSAcciónTool to retrieve a paginated list of custom fields. use after confirming you need to enumerate or inspect all custom fields with cursor-based pagination.
KIT_LIST_CUSTOM_FIELDSAcciónTool to retrieve a paginated list of custom fields. use after confirming you need to enumerate or inspect all custom fields with cursor-based pagination.
Parámetros de entrada
afterstringCursor for pagination; returns results after the specified cursor.
beforestringCursor for pagination; returns results before the specified cursor.
per_pageintegerNumber of results per page; defaults to 500 if not specified.
include_total_countstringIf set to 'true', includes the total count of records in the response.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List FormsKIT_LIST_FORMSAcciónTool to list all forms. use when you need to fetch forms with optional filters and pagination.
KIT_LIST_FORMSAcciónTool to list all forms. use when you need to fetch forms with optional filters and pagination.
Parámetros de entrada
typestringenumFilter forms by type.
embedhostedafterstringCursor for pagination; returns results after the specified cursor.
beforestringCursor for pagination; returns results before the specified cursor.
statusstringFilter forms by status (e.g., 'active', 'archived').
per_pageintegerNumber of forms to return per page.
include_total_countstringenumIf set to 'true', includes the total count of forms in the response.
truefalse
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SegmentsKIT_LIST_SEGMENTSAcciónTool to retrieve a paginated list of segments. use when you need to enumerate segments with cursor-based pagination for further processing or display.
KIT_LIST_SEGMENTSAcciónTool to retrieve a paginated list of segments. use when you need to enumerate segments with cursor-based pagination for further processing or display.
Parámetros de entrada
afterstringCursor for pagination; returns results after this cursor.
beforestringCursor for pagination; returns results before this cursor.
per_pageintegerNumber of segments to return per page (min 1).
include_total_countstringenumIf set to 'true', includes the total count of segments in the response.
truefalse
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SequencesKIT_LIST_SEQUENCESAcciónTool to retrieve a paginated list of all sequences. use when you need to enumerate sequences with pagination for further processing or display.
KIT_LIST_SEQUENCESAcciónTool to retrieve a paginated list of all sequences. use when you need to enumerate sequences with pagination for further processing or display.
Parámetros de entrada
afterstringCursor for pagination; returns results after the specified cursor.
beforestringCursor for pagination; returns results before the specified cursor.
per_pageintegerNumber of results per page (max 500).
include_total_countstringenumIf set to 'true', includes the total count in the pagination.
truefalse
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SubscribersKIT_LIST_SUBSCRIBERSAcciónTool to retrieve a list of subscribers. use when you need to fetch subscriber records with optional filtering, sorting, and pagination.
KIT_LIST_SUBSCRIBERSAcciónTool to retrieve a list of subscribers. use when you need to fetch subscriber records with optional filtering, sorting, and pagination.
Parámetros de entrada
afterstringCursor for pagination; returns subscribers after this cursor.
beforestringCursor for pagination; returns subscribers before this cursor.
statusstringFilter by subscriber status (e.g., 'active' or 'inactive').
per_pageintegerNumber of subscribers to return per page (min 1).
sort_fieldstringField by which to sort the subscribers.
sort_orderstringenumOrder in which to sort the results.
ascdesccreated_afterstringFilter to subscribers created after this date (YYYY-MM-DD).
email_addressstringExact email address to filter by.
updated_afterstringFilter to subscribers updated after this date (YYYY-MM-DD).
created_beforestringFilter to subscribers created before this date (YYYY-MM-DD).
updated_beforestringFilter to subscribers updated before this date (YYYY-MM-DD).
include_total_countstringenumIf set to 'true', includes the total count of subscribers in the response.
truefalse
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Subscribers For FormKIT_LIST_SUBSCRIBERS_FOR_FORMAcciónTool to retrieve subscribers for a specific form by id. use when you need to page or filter subscribers of a form.
KIT_LIST_SUBSCRIBERS_FOR_FORMAcciónTool to retrieve subscribers for a specific form by id. use when you need to page or filter subscribers of a form.
Parámetros de entrada
afterstringCursor for pagination; returns results after this cursor.
beforestringCursor for pagination; returns results before this cursor.
statusstringFilter subscribers by status (e.g., 'active').
form_idintegerObligatorioID of the form whose subscribers you want to retrieve.
per_pageintegerNumber of results to return per page (min 1).
added_afterstringReturn subscribers added to the form after this date/time (ISO 8601).
added_beforestringReturn subscribers added to the form before this date/time (ISO 8601).
created_afterstringReturn subscribers created after this date/time (ISO 8601).
created_beforestringReturn subscribers created before this date/time (ISO 8601).
include_total_countstringenumIf 'true', includes the total count of subscribers in the response.
truefalse
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TagsKIT_LIST_TAGSAcciónTool to retrieve a list of all tags. use when you need a complete inventory of tags for the kit account.
KIT_LIST_TAGSAcciónTool to retrieve a list of all tags. use when you need a complete inventory of tags for the kit account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Tag SubscribersKIT_LIST_TAG_SUBSCRIBERSAcciónTool to retrieve subscribers for a specific tag. use after confirming the tag id when you need to list subscribers associated with a tag.
KIT_LIST_TAG_SUBSCRIBERSAcciónTool to retrieve subscribers for a specific tag. use after confirming the tag id when you need to list subscribers associated with a tag.
Parámetros de entrada
afterstringCursor for pagination; returns subscribers after this cursor.
beforestringCursor for pagination; returns subscribers before this cursor.
statusstringFilter by subscriber status ('active' or 'inactive').
tag_idintegerObligatorioUnique identifier of the tag to retrieve subscribers for
per_pageintegerNumber of subscribers to return per page (min 1).
tagged_afterstringFilter to subscribers tagged after this timestamp (ISO 8601).
created_afterstringFilter to subscribers created after this timestamp (ISO 8601).
tagged_beforestringFilter to subscribers tagged before this timestamp (ISO 8601).
created_beforestringFilter to subscribers created before this timestamp (ISO 8601).
include_total_countstringenumIf set to 'true', includes total count of subscribers in the response.
truefalse
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Tag SubscriberKIT_TAG_SUBSCRIBERAcciónTool to associate a subscriber with a specific tag by id. use after confirming tag and subscriber ids when tagging a subscriber.
KIT_TAG_SUBSCRIBERAcciónTool to associate a subscriber with a specific tag by id. use after confirming tag and subscriber ids when tagging a subscriber.
Parámetros de entrada
tag_idintegerObligatorioID of the tag to assign
subscriber_idintegerObligatorioID of the subscriber to tag
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Tag Subscriber by EmailKIT_TAG_SUBSCRIBER_BY_EMAILAcciónTool to associate a subscriber with a tag using an email address. use when you have a tag id and subscriber email ready. use after confirming both resources exist.
KIT_TAG_SUBSCRIBER_BY_EMAILAcciónTool to associate a subscriber with a tag using an email address. use when you have a tag id and subscriber email ready. use after confirming both resources exist.
Parámetros de entrada
tag_idintegerObligatorioThe ID of the tag to assign to the subscriber
email_addressanyObligatorioemailThe subscriber's email address
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Account ColorsKIT_UPDATE_ACCOUNT_COLORSAcciónTool to update the list of colors for the account. use when customizing your kit account's color palette for broadcasts and templates.
KIT_UPDATE_ACCOUNT_COLORSAcciónTool to update the list of colors for the account. use when customizing your kit account's color palette for broadcasts and templates.
Parámetros de entrada
colorsstring[]ObligatorioList of hex color codes to set for the account (e.g., '#008000', '#FF0000').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Custom FieldKIT_UPDATE_CUSTOM_FIELDAcciónTool to update a custom field's label. use after listing or retrieving custom fields and confirming the field id to rename.
KIT_UPDATE_CUSTOM_FIELDAcciónTool to update a custom field's label. use after listing or retrieving custom fields and confirming the field id to rename.
Parámetros de entrada
idintegerObligatorioUnique identifier of the custom field to update
labelstringObligatorioNew label for the custom field
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update TagKIT_UPDATE_TAGAcciónTool to update a tag's name by id. use after retrieving tag id and confirming the new name.
KIT_UPDATE_TAGAcciónTool to update a tag's name by id. use after retrieving tag id and confirming the new name.
Parámetros de entrada
idintegerObligatorioUnique identifier of the tag to update
namestringObligatorioNew name for the tag
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Triggers (17)
Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).
Broadcast CreatedKIT_BROADCAST_CREATEDTriggerTriggers when a broadcast is created, including one saved as a draft. Kit emits this before it enforces the confirmed-send-address check, so a create the API reported as failed still fires it.
KIT_BROADCAST_CREATEDTriggerTriggers when a broadcast is created, including one saved as a draft. Kit emits this before it enforces the confirmed-send-address check, so a create the API reported as failed still fires it.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Broadcast DeletedKIT_BROADCAST_DELETEDTriggerTriggers when a broadcast is deleted.
KIT_BROADCAST_DELETEDTriggerTriggers when a broadcast is deleted.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Custom Field CreatedKIT_CUSTOM_FIELD_CREATEDTriggerTriggers when a custom field is defined on the account.
KIT_CUSTOM_FIELD_CREATEDTriggerTriggers when a custom field is defined on the account.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Custom Field DeletedKIT_CUSTOM_FIELD_DELETEDTriggerTriggers when a custom field is deleted from the account.
KIT_CUSTOM_FIELD_DELETEDTriggerTriggers when a custom field is deleted from the account.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Sequence CreatedKIT_SEQUENCE_CREATEDTriggerTriggers when an email sequence is created. Kit creates sequences already active, so `KIT_SEQUENCE_PUBLISHED` does not also fire.
KIT_SEQUENCE_CREATEDTriggerTriggers when an email sequence is created. Kit creates sequences already active, so `KIT_SEQUENCE_PUBLISHED` does not also fire.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Sequence DeletedKIT_SEQUENCE_DELETEDTriggerTriggers when an email sequence is deleted.
KIT_SEQUENCE_DELETEDTriggerTriggers when an email sequence is deleted.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Sequence DisabledKIT_SEQUENCE_DISABLEDTriggerTriggers when a published email sequence is disabled. Only a real active-to-disabled transition fires it — disabling a sequence that is already disabled emits nothing.
KIT_SEQUENCE_DISABLEDTriggerTriggers when a published email sequence is disabled. Only a real active-to-disabled transition fires it — disabling a sequence that is already disabled emits nothing.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Sequence PublishedKIT_SEQUENCE_PUBLISHEDTriggerTriggers when a disabled email sequence is published. Only a real disabled-to-active transition fires it — publishing a sequence that is already active emits nothing.
KIT_SEQUENCE_PUBLISHEDTriggerTriggers when a disabled email sequence is published. Only a real disabled-to-active transition fires it — publishing a sequence that is already active emits nothing.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Subscriber ActivatedKIT_SUBSCRIBER_ACTIVATEDTriggerTriggers when a subscriber becomes active — a double opt-in signup is confirmed, a past subscriber re-subscribes, or a new subscriber is created active. Use `KIT_SUBSCRIBER_CREATED` for the moment the record first appears instead.
KIT_SUBSCRIBER_ACTIVATEDTriggerTriggers when a subscriber becomes active — a double opt-in signup is confirmed, a past subscriber re-subscribes, or a new subscriber is created active. Use `KIT_SUBSCRIBER_CREATED` for the moment the record first appears instead.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Subscriber Added To SequenceKIT_SUBSCRIBER_ADDED_TO_SEQUENCETriggerTriggers when a subscriber is added to an email sequence. Set `sequence_id` to watch a single sequence.
KIT_SUBSCRIBER_ADDED_TO_SEQUENCETriggerTriggers when a subscriber is added to an email sequence. Set `sequence_id` to watch a single sequence.
Configuración
sequence_idintegerOnly fire for this sequence. Leave unset to fire for every sequence. Use `KIT_LIST_SEQUENCES` to find sequence ids.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Subscriber CreatedKIT_SUBSCRIBER_CREATEDTriggerTriggers when a subscriber record is created on the account. A subscriber created through Kit's API is also activated in the same moment, so it fires `KIT_SUBSCRIBER_ACTIVATED` as a second, separate event.
KIT_SUBSCRIBER_CREATEDTriggerTriggers when a subscriber record is created on the account. A subscriber created through Kit's API is also activated in the same moment, so it fires `KIT_SUBSCRIBER_ACTIVATED` as a second, separate event.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Subscriber Custom Field Value UpdatedKIT_SUBSCRIBER_CUSTOM_FIELD_VALUE_UPDATEDTriggerTriggers when a subscriber's custom field value changes, including the first time it is set. Kit sends one event per field changed. Set `custom_field_key` to watch a single field.
KIT_SUBSCRIBER_CUSTOM_FIELD_VALUE_UPDATEDTriggerTriggers when a subscriber's custom field value changes, including the first time it is set. Kit sends one event per field changed. Set `custom_field_key` to watch a single field.
Configuración
custom_field_keystringOnly fire when this custom field changes, addressed by its key (e.g. 'lifecycle_stage'). Leave unset to fire for every field. Use `KIT_LIST_CUSTOM_FIELDS` to see the keys defined on the account.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Subscriber Tag AddedKIT_SUBSCRIBER_TAG_ADDEDTriggerTriggers when a tag is added to a subscriber. Set `tag_id` to watch a single tag.
KIT_SUBSCRIBER_TAG_ADDEDTriggerTriggers when a tag is added to a subscriber. Set `tag_id` to watch a single tag.
Configuración
tag_idintegerOnly fire for this tag. Leave unset to fire for every tag. Use `KIT_LIST_TAGS` to find tag ids.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Subscriber Tag RemovedKIT_SUBSCRIBER_TAG_REMOVEDTriggerTriggers when a tag is removed from an individual subscriber. Deleting the tag itself fires `KIT_TAG_DELETED` once instead of this event per subscriber. Set `tag_id` to watch a single tag.
KIT_SUBSCRIBER_TAG_REMOVEDTriggerTriggers when a tag is removed from an individual subscriber. Deleting the tag itself fires `KIT_TAG_DELETED` once instead of this event per subscriber. Set `tag_id` to watch a single tag.
Configuración
tag_idintegerOnly fire for this tag. Leave unset to fire for every tag. Use `KIT_LIST_TAGS` to find tag ids.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Subscriber UnsubscribedKIT_SUBSCRIBER_UNSUBSCRIBEDTriggerTriggers when a subscriber unsubscribes from the account's emails. The subscriber arrives with `state` set to 'cancelled'.
KIT_SUBSCRIBER_UNSUBSCRIBEDTriggerTriggers when a subscriber unsubscribes from the account's emails. The subscriber arrives with `state` set to 'cancelled'.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Tag CreatedKIT_TAG_CREATEDTriggerTriggers when a tag is created on the account.
KIT_TAG_CREATEDTriggerTriggers when a tag is created on the account.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').
Tag DeletedKIT_TAG_DELETEDTriggerTriggers when a tag is deleted from the account. This is the only event the deletion produces, so a workflow mirroring tag membership must drop the tag from every subscriber here — `KIT_SUBSCRIBER_TAG_REMOVED` does not fire per subscriber.
KIT_TAG_DELETEDTriggerTriggers when a tag is deleted from the account. This is the only event the deletion produces, so a workflow mirroring tag membership must drop the tag from every subscriber here — `KIT_SUBSCRIBER_TAG_REMOVED` does not fire per subscriber.
Configuración
Sin parámetros.
Payload del evento
createdstringObligatorioRFC3339 timestamp of the underlying change (not the delivery time).
dataobjectObligatorioThe Kit resources the event is about.
typestringObligatorioThe Kit event type that fired (e.g. 'subscriber.tag_added').