Pular para o conteúdo
API de admissãov1OpenAPIPara IA

Avisos — referência

O Motor faz POST no endereço do webhook da integração da empresa. Todo aviso tem o mesmo corpo e os mesmos cabeçalhos; muda o evento. As regras de entrega e a conferência da assinatura estão em Avisos (webhook).

O corpo de todo aviso

  • iduuidobrigatório

    Igual ao cabeçalho X-Motor-Aviso-Id.

  • eventotextoobrigatório
    ValorSignificado
    admissao.processadaO eSocial aceitou o S-2200.
    admissao.recusadaO eSocial recusou o S-2200.
    admissao.descartadaO escritório descartou o evento antes de enviá-lo.
    admissao.aguardando_escritorioO envio automático parou e o evento está na fila do escritório.
  • ocorrido_emdata e hora (ISO 8601)obrigatório

    Quando a mudança de estado aconteceu no Motor (não quando o aviso foi entregue).

  • ambientetextoobrigatório

    Ambiente do eSocial da empresa.

    ValorSignificado
    PRODUCAOProdução (com valor legal).
    RESTRITAProdução Restrita (teste, sem valor legal).
  • admissaoobjetoobrigatório
    Campos de admissao (6)
    • iduuidobrigatório
    • estadotextoobrigatório

      Onde a admissão está.

      ValorSignificado
      RECEBIDAColaborador criado; o evento está sendo montado.
      AGUARDANDO_ESCRITORIOO evento está na fila do escritório, esperando uma pessoa aprovar.
      ENVIADATransmitido; aguardando o processamento do eSocial.
      PROCESSADAAceito pelo eSocial; há nr_recibo.
      RECUSADARecusado pelo eSocial; veja ocorrencias. Se o escritório corrigir e reenviar, pode voltar a ENVIADA; não a trate como final.
      DESCARTADAO escritório descartou o evento sem enviá-lo. Pode voltar se ele o restaurar.
    • matriculatextoobrigatório

      até 30 caracteres

    • nr_recibotexto ou nullobrigatório

      formato ^1\.\d\.\d{19}$

    • ocorrenciaslista de objetoobrigatório
      Campos de ocorrencias (4)
      • codigotexto ou nullobrigatório
      • descricaotexto ou nullobrigatório
      • tipotexto ou nullobrigatório

        Tipo da ocorrência no retorno do eSocial (erro ou advertência).

      • localizacaotexto ou nullobrigatório
    • motivotexto ou nullobrigatório

      Em descartada, o motivo escrito pelo escritório (opcional para ele); em aguardando_escritorio, por que o envio automático parou.

admissao.processada

O eSocial aceitou o S-2200

O recibo está em admissao.nr_recibo. Os XML vêm pela consulta.

Cabeçalhos (3)
  • X-Motor-Aviso-Iduuidcabeçalhoobrigatório

    Id do aviso, igual ao id do corpo. Use para descartar duplicatas.

  • X-Motor-Eventotextocabeçalhoobrigatório

    O que aconteceu, igual ao evento do corpo.

    ValorSignificado
    admissao.processadaO eSocial aceitou o S-2200.
    admissao.recusadaO eSocial recusou o S-2200.
    admissao.descartadaO escritório descartou o evento antes de enviá-lo.
    admissao.aguardando_escritorioO envio automático parou e o evento está na fila do escritório.
  • X-Motor-Assinaturatextocabeçalhoobrigatório

    t=<unix>,v1=<hex>, onde v1 é o HMAC-SHA256, em hexadecimal minúsculo, de t + "." + corpo cru, com o segredo do webhook (texto UTF-8, exatamente como foi mostrado) como chave. Confira sobre os BYTES recebidos, antes de interpretar o JSON.

    formato ^t=\d+,v1=[0-9a-f]{64}$

2XX

Recebido. Qualquer outra resposta, ou nenhuma em 10 s, gera nova tentativa.

admissao.recusada

O eSocial recusou o S-2200

As ocorrências do eSocial estão em admissao.ocorrencias. O escritório também é avisado. O envio automático nunca reenvia. Se o escritório corrigir e reenviar, a mesma admissão pode voltar a ENVIADA e gerar novo aviso no fim: não trate recusada como final.

Cabeçalhos (3)
  • X-Motor-Aviso-Iduuidcabeçalhoobrigatório

    Id do aviso, igual ao id do corpo. Use para descartar duplicatas.

  • X-Motor-Eventotextocabeçalhoobrigatório

    O que aconteceu, igual ao evento do corpo.

    ValorSignificado
    admissao.processadaO eSocial aceitou o S-2200.
    admissao.recusadaO eSocial recusou o S-2200.
    admissao.descartadaO escritório descartou o evento antes de enviá-lo.
    admissao.aguardando_escritorioO envio automático parou e o evento está na fila do escritório.
  • X-Motor-Assinaturatextocabeçalhoobrigatório

    t=<unix>,v1=<hex>, onde v1 é o HMAC-SHA256, em hexadecimal minúsculo, de t + "." + corpo cru, com o segredo do webhook (texto UTF-8, exatamente como foi mostrado) como chave. Confira sobre os BYTES recebidos, antes de interpretar o JSON.

    formato ^t=\d+,v1=[0-9a-f]{64}$

2XX

Recebido. Qualquer outra resposta, ou nenhuma em 10 s, gera nova tentativa.

admissao.descartada

O escritório descartou o evento antes de enviá-lo

O S-2200 não foi e não será enviado por esta admissão, salvo se o escritório o restaurar. O colaborador continua cadastrado no Motor.

Cabeçalhos (3)
  • X-Motor-Aviso-Iduuidcabeçalhoobrigatório

    Id do aviso, igual ao id do corpo. Use para descartar duplicatas.

  • X-Motor-Eventotextocabeçalhoobrigatório

    O que aconteceu, igual ao evento do corpo.

    ValorSignificado
    admissao.processadaO eSocial aceitou o S-2200.
    admissao.recusadaO eSocial recusou o S-2200.
    admissao.descartadaO escritório descartou o evento antes de enviá-lo.
    admissao.aguardando_escritorioO envio automático parou e o evento está na fila do escritório.
  • X-Motor-Assinaturatextocabeçalhoobrigatório

    t=<unix>,v1=<hex>, onde v1 é o HMAC-SHA256, em hexadecimal minúsculo, de t + "." + corpo cru, com o segredo do webhook (texto UTF-8, exatamente como foi mostrado) como chave. Confira sobre os BYTES recebidos, antes de interpretar o JSON.

    formato ^t=\d+,v1=[0-9a-f]{64}$

2XX

Recebido. Qualquer outra resposta, ou nenhuma em 10 s, gera nova tentativa.

admissao.aguardando_escritorio

O envio automático parou e o evento está na fila do escritório

Só sai quando o envio automático estava ligado na chegada da admissão e para no meio: o evento não montou; o envio automático foi desligado; a admissão foi alterada no Motor depois de recebida; o envio teve erro técnico, o certificado não pôde ser usado ou o eSocial precisa de outro evento antes deste (o envio automático nunca tenta de novo); o escritório está suspenso; ou uma falha do Motor impediu o envio automático de terminar. admissao.motivo diz qual, em texto para pessoas — não decida por ele. Também sai quando a chave que enviou a admissão é revogada antes do envio: revogar existe para cortar um canal que pode estar comprometido, então o que entrou por ele não é transmitido sem que uma pessoa do escritório aprove. Com o envio automático desligado, esperar o escritório é o normal e este aviso não sai.

O aviso vai ao endereço do webhook da integração da empresa, que não muda com a troca de chave. Sem endereço cadastrado, os avisos não saem (o andamento fica na consulta); cadastrado depois, só os avisos novos saem. Redirecionamento não é seguido (3xx conta como falha de entrega).

Cabeçalhos (3)
  • X-Motor-Aviso-Iduuidcabeçalhoobrigatório

    Id do aviso, igual ao id do corpo. Use para descartar duplicatas.

  • X-Motor-Eventotextocabeçalhoobrigatório

    O que aconteceu, igual ao evento do corpo.

    ValorSignificado
    admissao.processadaO eSocial aceitou o S-2200.
    admissao.recusadaO eSocial recusou o S-2200.
    admissao.descartadaO escritório descartou o evento antes de enviá-lo.
    admissao.aguardando_escritorioO envio automático parou e o evento está na fila do escritório.
  • X-Motor-Assinaturatextocabeçalhoobrigatório

    t=<unix>,v1=<hex>, onde v1 é o HMAC-SHA256, em hexadecimal minúsculo, de t + "." + corpo cru, com o segredo do webhook (texto UTF-8, exatamente como foi mostrado) como chave. Confira sobre os BYTES recebidos, antes de interpretar o JSON.

    formato ^t=\d+,v1=[0-9a-f]{64}$

2XX

Recebido. Qualquer outra resposta, ou nenhuma em 10 s, gera nova tentativa.