Webhooks

Criar webhook

Cria um novo webhook para o tenant, assinando um evento da plataforma (por exemplo, criação de uma candidatura ou alteração de etapa). Ao ocorrer o evento, a InHire envia uma requisição HTTP POST para a url informada com os dados do evento. É possível restringir o disparo a usuários de grupos específicos via userGroups e adicionar regras de filtragem por campo via rules.

post/integrations/webhooks

Request

  • Base URL: https://api.inhire.app
  • URL: https://api.inhire.app/integrations/webhooks
  • Auth: HTTP bearer

Headers

X-Tenantstring required

Multi-tenant identifier. Required on every request. This determines which tenant's data the request operates on. Maps to the DynamoDB partition key (tenantId).

Request body

event'JOB_ADDED' | 'JOB_UPDATED' | 'JOB_REMOVED' | 'JOB_TALENT_ADDED' | 'JOB_TALENT_STAGE_ADDED' | 'JOB_TALENT_UPDATED' | 'JOB_TALENT_FIT_UPDATED' | 'FORM_RESPONSE_ADDED' | 'JOB_PAGE_CREATED' | 'JOB_PAGE_UPDATED' | 'REQUISITION_CREATED' | 'REQUISITION_STATUS_UPDATED' required

Nome do evento que disparou o webhook.

namestring required

Nome legível do recurso.

urlstring required

URL pública.

rulesobject

Regras avaliadas pelo recurso (condições + ações).

descriptionstring

Descrição em texto livre do recurso.

headersobject

Headers HTTP enviados na requisição saída do webhook/integração.

Response

Created

statusCodenumber required

Changes

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