Webhooks

Listar webhooks por evento

Retorna todos os webhooks do tenant que estão assinando um evento específico, identificado pelo eventName (por exemplo, JOB_TALENT_ADDED).

get/integrations/webhooks/event/{eventName}

Request

  • Base URL: https://api.inhire.app
  • URL: https://api.inhire.app/integrations/webhooks/event/{eventName}
  • Auth: HTTP bearer

Path parameters

eventNamestring required

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).

Response

OK

createdAtstring required

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

descriptionstring

Descrição em texto livre do recurso.

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

Nome do evento que disparou o webhook.

headersobject

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

idstring required

Identificador único do recurso (ULID).

namestring required

Nome legível do recurso.

rulesobject

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

tenantIdstring required

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

updatedAtstring required

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

urlstring required

URL pública.

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.