Webhooks

Um Webhook é uma forma automatizada de enviar informações entre sistemas quando certos eventos ocorrem. Quando você ativa um Webhook, ele passará a enviar requisições POST para o endereço configurado sempre que determinado evento acontecer. Essa requisição incluirá informações sobre o evento e o recurso envolvido.

Com o PHPay a gestão dos seus webhooks do Asaas também funcionam de forma muito simples conforme os exemplos a abaixo:

Criar um Novo Webhook

você poderá ver os campos necessários e mais detalhes na própria documentação do Asaas clicando aqui.

/**
 * @return array
 * @see available fields in https://docs.asaas.com/reference/criar-novo-webhook
 */
$phpay
    ->webhook($webhook)
    ->create();

Listagem de Webhooks

/**
 * @return array
 */
$phpay
    ->webhook()
    ->getAll();

Localizar um Webhook

/**
 * @return array
 */
$phpay
    ->webhook()
    ->find($webhookId);

Editar um Webhook

Para ver mais detalhes dos campos disponíveis para edição, você pode ver diretamente pela documentação do Asaas clicando aqui.

/**
 * @return array
 * @see available fields in https://docs.asaas.com/reference/atualizar-webhook-existente
 */
$phpay
    ->webhook()
    ->update($webhookId, [
        'name' => 'Webhook de Teste Atualizado',
        'url'  => 'https://phpay.io/webhook/listener',
    ]);

Excluir Webhook

/**
 * @return bool
 */
$webhookDeleted = $phpay
    ->webhook()
    ->destroy($webhookId);
Updated on