Automações

Listar automações

Retorna uma lista de automações de uma vaga.

get/workflows/automations

Request

  • Base URL: https://api.inhire.app
  • URL: https://api.inhire.app/workflows/automations
  • Auth: none required

Query parameters

origin'screening-agent'

Filtra pela origem da automação. Sem o parâmetro, a listagem exclui as ações do agente de triagem (origin: screening-agent); com origin=screening-agent, retorna apenas elas.

Headers

Authorizationstring required

Response

OK

actionDisplayNamestring required

Nome textual de actionDisplay.

actionName'COMMS_SEND_EMAIL' | 'COMMS_SEND_WHATSAPP' | 'FORMS_SEND_TEST' | 'FORMS_SEND_SUBSCRIPTION' | 'EXTERNAL_API_SEND_REQUEST' | 'JOB_TALENT_MOVE_TO_STAGE' | 'JOB_TALENT_REPROVE_AND_SEND_EMAIL' | 'FORMS_SEND_DISC_TEST' | 'FORMS_SEND_DISC_TEST_WHATSAPP' | 'FORMS_SEND_TEST_WHATSAPP' | 'FORMS_SEND_SUBSCRIPTION_WHATSAPP' | 'COMMS_SEND_SCHEDULING_LINK_WHATSAPP' | 'FORMS_SEND_SURVEY_EXPERIENCE' required

Nome textual de action.

complementsobject

Informações complementares do recurso.

createdAtstring required

Timestamp ISO-8601 de criação do recurso.

delayInMinutesnumber

Atraso (em minutos) antes da execução da ação/automação.

idstring required

Identificador único do recurso (ULID).

jobIdstring

Identificador da vaga.

namestring required

Nome legível do recurso.

skipOnDuplicationboolean

Quando true, este item é ignorado em operações de duplicação da vaga/recurso.

status'ACTIVE' | 'INACTIVE' required

Status atual do recurso (enum específico do domínio).

tenantIdstring required

Identificador do tenant (cliente InHire) ao qual o recurso pertence.

triggerDisplayNamestring required

Nome textual de triggerDisplay.

triggerName'JOB_TALENT_STAGE_CHANGE' | 'JOB_TALENT_ADDED' | 'JOB_TALENT_ADDED_MANUALLY' | 'JOB_TALENT_ADDED_ALL_SOURCES' | 'SUBSCRIPTION_FORM_RESPONSE_ANSWERED' | 'SUBSCRIPTION_FORM_RESPONSE_PASSED' | 'SUBSCRIPTION_FORM_RESPONSE_REPROVED' | 'TEST_FORM_RESPONSE_PASSED' | 'TEST_FORM_RESPONSE_REPROVED' | 'TEST_FORM_RESPONSE_ANSWERED' | 'JOB_TALENT_INFORMED_SALARY_OUT_OF_RANGE' | 'JOB_TALENT_INFORMED_WORK_MODEL_NOT_AGREED' | 'JOB_TALENT_REPROVED' | 'JOB_TALENT_DECLINED' | 'SCREENING_AGENT_MAX_FIT' | 'SCREENING_AGENT_LOW_FIT' required

Nome textual de trigger.

updatedAtstring required

Timestamp ISO-8601 da última atualização do recurso.

userGroupsstring[] nullable

Lista de IDs dos grupos (teams) aos quais o usuário pertence.

userIdstring nullable required

Identificador do usuário associado ao recurso.

userNamestring required

Nome de exibição do usuário associado ao registro.

Changes

No recorded changes to this operation across all 1 revision of this API.