Page tree
Skip to end of metadata
Go to start of metadata

Get /automations

Provides the entire list of  automations

Returns the entire list of available automations.

An automation is an action to be automatically run under a trigger condition. Automations are restricted to a specific group for keeping real control over the individuals universe this action will be run.

Request URL

https://{client_id}.salesseek.net/api/automations

Response Type

Response content type: JSON Array[automations]

ModelExample of Response
Array[Automations]

Automation

{

action(Action): Resulting Action to be run when a user executes the trigger event of this automation,

called(timestamp): las time this automation run (due to its triggered event), formatted as YYYY-MM-ddThh_mm_ss.msecs,

created(timestamp): creation date for this automation, formatted as YYYY-MM-ddThh_mm_ss.msecs,

description(string): brief comment describing this automations intention (manually entered),

event(Event): Key of the automation: is the event which triggers the automation (any time this condition is met this automation will be run),

group(Group): Information about the group of individuals this automation will be focused,

/* this means if an individual who is not on this group executes the trigger event, the resulting action WON'T be run. */

group_id(string): id of the group of individuals this automation will be focused,

id(string): unique identifier for this automation,

modified(timestamp): last date this automation was modified, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): brief name to be shown as the automation title,

owner(User): information about the SalesSeek user who owns this automation, typically the creator,

owner_id(string): if of the SalesSeek user who owns this automation, typically the creator,

running(boolean): true or false if this automation is running (false for letting it paused)

}

Event(JSON): {

/* Key element in the automation, is the trigger event that makes the resulting action to be run */

type(Enum): Represents the trigger event condition, can be one of the followings: web_registration, group_join, group_leave, phase_change, individual_inactivity,

data(null. Phase or int*): depending on the event type the data will be one of the followings:

type*dataComments
web_registrationnullWeb Form registration has to be configured on SalesSeek Settings
group_joinnullwhen joining the group configured for this automation
group_leavenullwhen leaving the group configured for this automation
phase_changePhaseAny user belonging to an organization with a deal which changed to this specific phase
individual_inactivityintAn individual which latest activity (interaction) is older than the amount of days specified on data

}

Action(JSON): {

/* when a trigger is executed by a user this kind of action will be automatically run */

type(Enum): Represents the type of resulting action, can be one of the followings: post_activity, send_mailshot, change_phase, join_group, leave_group

data(one of the followings): The data asociated to the Action, depending on its type the data might be:

type*dataComments
post_activityBasic_NoteWill create a basic note on the activity stream of this user including the specified content
post_activityNote_Due_DateIf specified a target_date: this action will create a due date note on the activity stream of this user including the specified content and the due date calculated from today adding the specified amount of days
join_groupGroupThe user executing the trigger event will be added to this specific group
leave_groupGroupThe user executing the trigger event will be removed from this specific group
phase_changePhaseAll deals associated to the user executing the trigger event will be changed to the specified phase
send_mailshotMailshotWill send the specified Mailshot to the user executing the trigger event

 

}

Basic_Note(JSON) {

note(string):the text content of the note to be published as an activity associated to the current user

}

Note_Due_Date(JSON) {

note(string):the text content of the note to be published as an activity associated to the current user,

target_date(string): the amount of future days for stabilising a Due Date for this note

}

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

default_weight(number): weight representing a percentage (0..1) of probability to close a deal on this current phase, configured in SalesSeek Settings,

hint(string): a brief description about what makes a Deal to be included in this phase

short_id(string): shorter unique identifier for this phase,

type(string): "phases"

}

 

[
  0:{
    action: {
      data: {
        note: "call him: this user has been inactive for 2 weeks"
        target_date: 3
      }
      type: "post_activity"
    }
    called: null
    created: "2014-01-22T22:55:18.117701"
    description: ""
    event: {
      data: 14
      type: "individual_inactivity"
    }
    group: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "6449a5b4"
      name: "Inactive User"
      short_id: "645a5b4"
      type: "groups"
    }
    group_id: "6449a5b4"
    id: "dadf4f4"
    modified: "2014-01-22T23:10:35.183542"
    name: "no activitity after 2 weeks"
    owner: {
      id: "c8c2baa8956"
      name: "SalesSeek Support"
    }
    owner_id: "c8c2baa8956"
    running: false
  },
  1:{...}
]

 

Parameters

 

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-RowsOut-

Amount of records returned in this search

int
Records-StartOut-The index of the first row on the response (in case there are more results, paginated)int
Records-TotalOut-Total amount of records (even if are not in this search result)int
rowsInNThe maximum amount of element to be requestedint
startInNThe element number to start to retrieve the data (0 for the first position)int

 


 

 

POST  automation 

Creates a new  automation 

Creates a new  automation  and Returns the resulting  automation 

 

Request URL

https://{client_id}.salesseek.net/api/automation

Request Body
{
    action:{
        data:{
            note: "this user has been inactive for 2 weeks, take a decision"
        },
        type: "post_activity"
    },
    event: {
        data: 14,
        type: "individual_inactivity"
    },
    group: {
        cost: 0,
        cost_basis: "total",
        id: "644982b5-a8c9-48a2-9c9d-27624a95a5b4",
        name: "destinyTweets",
        permissions: [
            0: "salesseek.core.edit",
            1: "salesseek.core.all_permissions",
            2: "salesseek.core.view"
        ],
        short_id: "644982b5-a8c9-48a2-9c9d-27624a95a5b4",
        type: "groups"
    }
    name: "no activ 2 weeks"
}

 

Response Type

Response content type: JSON automation

ModelExample of Response

 

Automation

{

action(Action): Resulting Action to be run when a user executes the trigger event of this automation,

called(timestamp): las time this automation run (due to its triggered event), formatted as YYYY-MM-ddThh_mm_ss.msecs,

created(timestamp): creation date for this automation, formatted as YYYY-MM-ddThh_mm_ss.msecs,

description(string): brief comment describing this automations intention (manually entered),

event(Event): Key of the automation: is the event which triggers the automation (any time this condition is met this automation will be run),

group(Group): Information about the group of individuals this automation will be focused,

/* this means if an individual who is not on this group executes the trigger event, the resulting action WON'T be run. */

group_id(string): id of the group of individuals this automation will be focused,

id(string): unique identifier for this automation,

modified(timestamp): last date this automation was modified, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): brief name to be shown as the automation title,

owner(User): information about the SalesSeek user who owns this automation, typically the creator,

owner_id(string): if of the SalesSeek user who owns this automation, typically the creator,

running(boolean): true or false if this automation is running (false for letting it paused)

}

Event(JSON): {

/* Key element in the automation, is the trigger event that makes the resulting action to be run */

type(Enum): Represents the trigger event condition, can be one of the followings: web_registration, group_join, group_leave, phase_change, individual_inactivity,

data(null. Phase or int*): depending on the event type the data will be one of the followings:

type*dataComments
web_registrationnullWeb Form registration has to be configured on SalesSeek Settings
group_joinnullwhen joining the group configured for this automation
group_leavenullwhen leaving the group configured for this automation
phase_changePhaseAny user belonging to an organization with a deal which changed to this specific phase
individual_inactivityintAn individual which latest activity (interaction) is older than the amount of days specified on data

}

Action(JSON): {

/* when a trigger is executed by a user this kind of action will be automatically run */

type(Enum): Represents the type of resulting action, can be one of the followings: post_activity, send_mailshot, change_phase, join_group, leave_group

data(one of the followings): The data asociated to the Action, depending on its type the data might be:

type*dataComments
post_activityBasic_NoteWill create a basic note on the activity stream of this user including the specified content
post_activityNote_Due_DateIf specified a target_date: this action will create a due date note on the activity stream of this user including the specified content and the due date calculated from today adding the specified amount of days
join_groupGroupThe user executing the trigger event will be added to this specific group
leave_groupGroupThe user executing the trigger event will be removed from this specific group
phase_changePhaseAll deals associated to the user executing the trigger event will be changed to the specified phase
send_mailshotMailshotWill send the specified Mailshot to the user executing the trigger event

 

}

Basic_Note(JSON) {

note(string):the text content of the note to be published as an activity associated to the current user

}

Note_Due_Date(JSON) {

note(string):the text content of the note to be published as an activity associated to the current user,

target_date(string): the amount of future days for stabilising a Due Date for this note

}

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

default_weight(number): weight representing a percentage (0..1) of probability to close a deal on this current phase, configured in SalesSeek Settings,

hint(string): a brief description about what makes a Deal to be included in this phase

short_id(string): shorter unique identifier for this phase,

type(string): "phases"

}

 

{
    action: {
      data: {
        note: "this user has been inactive for 2 weeks, take a decision"
      }
      type: "post_activity"
    }
    called: null
    created: "2014-01-22T22:55:18.117701"
    description: ""
    event: {
      data: 14
      type: "individual_inactivity"
    }
    group: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "6449a5b4"
      name: "Inactive User"
      short_id: "645a5b4"
      type: "groups"
    }
    group_id: "6449a5b4"
    id: "dadf4f4"
    modified: "2014-01-22T23:10:35.183542"
    name: "no activitity after 2 weeks"
    owner: {
      id: "c8c2baa8956"
      name: "SalesSeek Support"
    }
    owner_id: "c8c2baa8956"
    running: true
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
userOut-The  automation  created after the successful requestJSON

 


 

DELETE /automations

Deletes a specific list automation by ID

Deletes a specific list automation by the IDs provided in the request body

Request URL

https://{client_id}.salesseek.net/api/automations

Request Body
{
    id:"889944",
    id:"889945"
}

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 automations _idsInYThe list of automations ids to be deletedstring

 


 

Get /automations/{automation _id} 

Provides the automation matching automation _id

Returns the unique automation matching the automation _Id

Request URL

https://{client_id}.salesseek.net/api/automations/69d1fbe62

Response Type

Response content type: Automation

ModelExample of Response

 

Automation

{

action(Action): Resulting Action to be run when a user executes the trigger event of this automation,

called(timestamp): las time this automation run (due to its triggered event), formatted as YYYY-MM-ddThh_mm_ss.msecs,

created(timestamp): creation date for this automation, formatted as YYYY-MM-ddThh_mm_ss.msecs,

description(string): brief comment describing this automations intention (manually entered),

event(Event): Key of the automation: is the event which triggers the automation (any time this condition is met this automation will be run),

group(Group): Information about the group of individuals this automation will be focused,

/* this means if an individual who is not on this group executes the trigger event, the resulting action WON'T be run. */

group_id(string): id of the group of individuals this automation will be focused,

id(string): unique identifier for this automation,

modified(timestamp): last date this automation was modified, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): brief name to be shown as the automation title,

owner(User): information about the SalesSeek user who owns this automation, typically the creator,

owner_id(string): if of the SalesSeek user who owns this automation, typically the creator,

running(boolean): true or false if this automation is running (false for letting it paused)

}

Event(JSON): {

/* Key element in the automation, is the trigger event that makes the resulting action to be run */

type(Enum): Represents the trigger event condition, can be one of the followings: web_registration, group_join, group_leave, phase_change, individual_inactivity,

data(null. Phase or int*): depending on the event type the data will be one of the followings:

type*dataComments
web_registrationnullWeb Form registration has to be configured on SalesSeek Settings
group_joinnullwhen joining the group configured for this automation
group_leavenullwhen leaving the group configured for this automation
phase_changePhaseAny user belonging to an organization with a deal which changed to this specific phase
individual_inactivityintAn individual which latest activity (interaction) is older than the amount of days specified on data

}

Action(JSON): {

/* when a trigger is executed by a user this kind of action will be automatically run */

type(Enum): Represents the type of resulting action, can be one of the followings: post_activity, send_mailshot, change_phase, join_group, leave_group

data(one of the followings): The data asociated to the Action, depending on its type the data might be:

type*dataComments
post_activityBasic_NoteWill create a basic note on the activity stream of this user including the specified content
post_activityNote_Due_DateIf specified a target_date: this action will create a due date note on the activity stream of this user including the specified content and the due date calculated from today adding the specified amount of days
join_groupGroupThe user executing the trigger event will be added to this specific group
leave_groupGroupThe user executing the trigger event will be removed from this specific group
phase_changePhaseAll deals associated to the user executing the trigger event will be changed to the specified phase
send_mailshotMailshotWill send the specified Mailshot to the user executing the trigger event

 

}

Basic_Note(JSON) {

note(string):the text content of the note to be published as an activity associated to the current user

}

Note_Due_Date(JSON) {

note(string):the text content of the note to be published as an activity associated to the current user,

target_date(string): the amount of future days for stabilising a Due Date for this note

}

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

default_weight(number): weight representing a percentage (0..1) of probability to close a deal on this current phase, configured in SalesSeek Settings,

hint(string): a brief description about what makes a Deal to be included in this phase

short_id(string): shorter unique identifier for this phase,

type(string): "phases"

}

 

{
    action: {
      data: {
        note: "this user has been inactive for 2 weeks, take a decision"
      }
      type: "post_activity"
    }
    called: null
    created: "2014-01-22T22:55:18.117701"
    description: ""
    event: {
      data: 14
      type: "individual_inactivity"
    }
    group: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "6449a5b4"
      name: "Inactive User"
      short_id: "645a5b4"
      type: "groups"
    }
    group_id: "6449a5b4"
    id: "dadf4f4"
    modified: "2014-01-22T23:10:35.183542"
    name: "no activitity after 2 weeks"
    owner: {
      id: "c8c2baa8956"
      name: "SalesSeek Support"
    }
    owner_id: "c8c2baa8956"
    running: true
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 automation  _idInYThe id of   automation   to be getstring
 automation Out-The  requested  automation  JSON

 

 


 

 

PATCH /automations/{automation _id}

Updates a specific automation by ID

Updates an  automation by {automation _id} and Returns the resulting element .

The fields updated are just the ones passed on the request body

Request URL

https://{client_id}.salesseek.net/api/automations/a3451f5--640585a5d026

Request Body
{
    action: {
      data: {
        note: "this user has been inactive for 1 week, take a decision"
      }
      type: "post_activity"
    }
    event: {
      data: 7
      type: "individual_inactivity"
    }
}

 

Response Type

Response content type: JSON automation

ModelExample of Response

 

Automation

{

action(Action): Resulting Action to be run when a user executes the trigger event of this automation,

called(timestamp): las time this automation run (due to its triggered event), formatted as YYYY-MM-ddThh_mm_ss.msecs,

created(timestamp): creation date for this automation, formatted as YYYY-MM-ddThh_mm_ss.msecs,

description(string): brief comment describing this automations intention (manually entered),

event(Event): Key of the automation: is the event which triggers the automation (any time this condition is met this automation will be run),

group(Group): Information about the group of individuals this automation will be focused,

/* this means if an individual who is not on this group executes the trigger event, the resulting action WON'T be run. */

group_id(string): id of the group of individuals this automation will be focused,

id(string): unique identifier for this automation,

modified(timestamp): last date this automation was modified, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): brief name to be shown as the automation title,

owner(User): information about the SalesSeek user who owns this automation, typically the creator,

owner_id(string): if of the SalesSeek user who owns this automation, typically the creator,

running(boolean): true or false if this automation is running (false for letting it paused)

}

Event(JSON): {

/* Key element in the automation, is the trigger event that makes the resulting action to be run */

type(Enum): Represents the trigger event condition, can be one of the followings: web_registration, group_join, group_leave, phase_change, individual_inactivity,

data(null. Phase or int*): depending on the event type the data will be one of the followings:

type*dataComments
web_registrationnullWeb Form registration has to be configured on SalesSeek Settings
group_joinnullwhen joining the group configured for this automation
group_leavenullwhen leaving the group configured for this automation
phase_changePhaseAny user belonging to an organization with a deal which changed to this specific phase
individual_inactivityintAn individual which latest activity (interaction) is older than the amount of days specified on data

}

Action(JSON): {

/* when a trigger is executed by a user this kind of action will be automatically run */

type(Enum): Represents the type of resulting action, can be one of the followings: post_activity, send_mailshot, change_phase, join_group, leave_group

data(one of the followings): The data asociated to the Action, depending on its type the data might be:

type*dataComments
post_activityBasic_NoteWill create a basic note on the activity stream of this user including the specified content
post_activityNote_Due_DateIf specified a target_date: this action will create a due date note on the activity stream of this user including the specified content and the due date calculated from today adding the specified amount of days
join_groupGroupThe user executing the trigger event will be added to this specific group
leave_groupGroupThe user executing the trigger event will be removed from this specific group
phase_changePhaseAll deals associated to the user executing the trigger event will be changed to the specified phase
send_mailshotMailshotWill send the specified Mailshot to the user executing the trigger event

 

}

Basic_Note(JSON) {

note(string):the text content of the note to be published as an activity associated to the current user

}

Note_Due_Date(JSON) {

note(string):the text content of the note to be published as an activity associated to the current user,

target_date(string): the amount of future days for stabilising a Due Date for this note

}

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

default_weight(number): weight representing a percentage (0..1) of probability to close a deal on this current phase, configured in SalesSeek Settings,

hint(string): a brief description about what makes a Deal to be included in this phase

short_id(string): shorter unique identifier for this phase,

type(string): "phases"

}

 

{
    action: {
      data: {
        note: "this user has been inactive for 1 week, take a decision"
      }
      type: "post_activity"
    }
    called: null
    created: "2014-01-22T22:55:18.117701"
    description: ""
    event: {
      data: 7
      type: "individual_inactivity"
    }
    group: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "6449a5b4"
      name: "Inactive User"
      short_id: "645a5b4"
      type: "groups"
    }
    group_id: "6449a5b4"
    id: "dadf4f4"
    modified: "2014-01-22T23:10:35.183542"
    name: "no activitity after 2 weeks"
    owner: {
      id: "c8c2baa8956"
      name: "SalesSeek Support"
    }
    owner_id: "c8c2baa8956"
    running: true
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 automation _idInYThe id of the  automation  to be updatedstring
 automation InYThe subset of the  automation  model fields to be updatedJSON
 automation OutThe  automation  after the successful updateJSON

 

 


 

DELETE /automations/{automation _id}

Deletes a specific automation by its ID

Delete a automation by {automation _id}

Request URL

https://{client_id}.salesseek.net/api/automations/a3451f5  

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 automation _idInYThe id of  automation  to be deletedstring
  • No labels