Automações

Listar as execuções de uma automação

Retorna uma lista de execuções agendadas, executadas ou canceladas de uma automação.

get/workflows/executions

Request

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

Query parameters

origin'screening-agent'

Filtra pela origem da automação que gerou a execução. Sem o parâmetro, a listagem exclui as execuções de automaçõ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.

automationIdstring required

Identificador(es) de automation.

automationNamestring required

Nome textual de automation.

bodyobject

Corpo (HTML/texto) do recurso — usado por templates de e-mail, mensagens e webhooks.

canceledAtstring

Timestamp ISO-8601.

complementsobject

Informações complementares do recurso.

createdAtstring required

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

errorstring

Mensagem de erro retornada pela execução.

executedAtstring

Timestamp ISO-8601.

executionNamestring

Nome textual de execution.

idstring required

Identificador único do recurso (ULID).

jobIdstring

Identificador da vaga.

outputstring

Saída/resultado da execução do recurso.

scheduledToRunAtstring

Timestamp ISO-8601.

status'SCHEDULED' | 'RUNNING' | 'CANCELLED' | 'FAILED' | 'SUCCEEDED' | 'SKIPPED' required

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

statusReasonstring

Motivo associado ao status atual (ex.: razão do cancelamento ou rejeição).

talentIdstring

Identificador do talento (candidato).

talentNamestring

Nome textual de talent.

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.

userIdstring

Identificador do usuário associado ao recurso.

userNamestring

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

Changes

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