Automações

Atualizar uma automação

Atualiza uma automação. O campo origin é imutável (não pode ser alterado após a criação). Automações do agente de triagem (origin: screening-agent) só aceitam atualização de status, complements, delayInMinutes e name — qualquer outro campo no body é rejeitado. Para essas automações, um complements inválido para o trigger (ex.: stageId ausente em SCREENING_AGENT_MAX_FIT, ou reason fora do lexicon de motivos de reprovação em SCREENING_AGENT_LOW_FIT) retorna 400.

patch/workflows/automations/{id}

Request

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

Path parameters

idstring required

Headers

Authorizationstring required

Request body

namestring

Nome legível do recurso.

actionDisplayName'Enviar e-mail' | 'Enviar teste para o talento' | 'Enviar formulário para o talento' | 'Enviar dados da vaga e do talento para uma API' | 'Mover talento para a etapa' | 'Reprovar talento e enviar devolutiva'

Nome textual de actionDisplay.

actionName'COMMS_SEND_EMAIL' | 'FORMS_SEND_TEST' | 'FORMS_SEND_SUBSCRIPTION' | 'EXTERNAL_API_SEND_REQUEST' | 'JOB_TALENT_MOVE_TO_STAGE' | 'JOB_TALENT_REPROVE_AND_SEND_EMAIL'

Nome textual de action.

triggerDisplayName'Talento mudar de etapa' | 'Talento passou no formulário personalizado' | 'Talento reprovou no formulário personalizado' | 'Talento respondeu o formulário personalizado' | 'Talento passou no teste' | 'Talento reprovou no teste' | 'Talento respondeu o teste' | 'Talento se inscreveu'

Nome textual de triggerDisplay.

triggerName'JOB_TALENT_STAGE_CHANGE' | 'SUBSCRIPTION_FORM_RESPONSE_PASSED' | 'SUBSCRIPTION_FORM_RESPONSE_REPROVED' | 'SUBSCRIPTION_FORM_RESPONSE_ANSWERED' | 'TEST_FORM_RESPONSE_PASSED' | 'TEST_FORM_RESPONSE_REPROVED' | 'TEST_FORM_RESPONSE_ANSWERED' | 'JOB_TALENT_ADDED' | 'SCREENING_AGENT_MAX_FIT' | 'SCREENING_AGENT_LOW_FIT'

Nome textual de trigger.

delayInMinutesnumber

Tempo em minutos para a automação ser executada após o gatilho. Recomenda-se um tempo maior que 2 minutos

jobIdstring

Id da vaga que a automação será aplicada

Example request

{
  "name": "Enviar dados para API Externa",
  "actionDisplayName": "Enviar dados da vaga e do talento para uma API",
  "actionName": "EXTERNAL_API_SEND_REQUEST",
  "triggerDisplayName": "Talento mudar de etapa",
  "triggerName": "JOB_TALENT_STAGE_CHANGE",
  "complements": {
    "url": "https://webhook.site/71f7a92d-2f19-457e-a1f2-b8223e542b9b",
    "method": "POST"
  },
  "conditions": [
    {
      "field": "stageName",
      "operator": "EQUALS",
      "value": "Contratação"
    }
  ],
  "delayInMinutes": 5,
  "jobId": "d9d58e55-df92-447d-8180-778423c47870"
}

Response

OK

object required

Changes

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