Class WebhookControllerApi

Hierarchy

Constructors

Properties

Methods

createAccountWebhook createAccountWebhookRaw createWebhook createWebhookForPhoneNumber createWebhookForPhoneNumberRaw createWebhookRaw deleteAllWebhooks deleteAllWebhooksRaw deleteWebhook deleteWebhookById deleteWebhookByIdRaw deleteWebhookRaw getAllAccountWebhooks getAllAccountWebhooksRaw getAllWebhookResults getAllWebhookResultsRaw getAllWebhooks getAllWebhooksRaw getInboxWebhooksPaginated getInboxWebhooksPaginatedRaw getJsonSchemaForWebhookEvent getJsonSchemaForWebhookEventRaw getJsonSchemaForWebhookPayload getJsonSchemaForWebhookPayloadRaw getPhoneNumberWebhooksPaginated getPhoneNumberWebhooksPaginatedRaw getTestWebhookPayload getTestWebhookPayloadBounce getTestWebhookPayloadBounceRaw getTestWebhookPayloadBounceRecipient getTestWebhookPayloadBounceRecipientRaw getTestWebhookPayloadDeliveryStatus getTestWebhookPayloadDeliveryStatusRaw getTestWebhookPayloadEmailOpened getTestWebhookPayloadEmailOpenedRaw getTestWebhookPayloadEmailRead getTestWebhookPayloadEmailReadRaw getTestWebhookPayloadForWebhook getTestWebhookPayloadForWebhookRaw getTestWebhookPayloadNewAttachment getTestWebhookPayloadNewAttachmentRaw getTestWebhookPayloadNewContact getTestWebhookPayloadNewContactRaw getTestWebhookPayloadNewEmail getTestWebhookPayloadNewEmailRaw getTestWebhookPayloadNewSms getTestWebhookPayloadNewSmsRaw getTestWebhookPayloadRaw getWebhook getWebhookRaw getWebhookResult getWebhookResultRaw getWebhookResults getWebhookResultsCount getWebhookResultsCountRaw getWebhookResultsRaw getWebhookResultsUnseenErrorCount getWebhookResultsUnseenErrorCountRaw getWebhooks getWebhooksRaw redriveAllWebhookResults redriveAllWebhookResultsRaw redriveWebhookResult redriveWebhookResultRaw request sendTestData sendTestDataRaw updateWebhookHeaders updateWebhookHeadersRaw verifyWebhookSignature verifyWebhookSignatureRaw waitForWebhookResults waitForWebhookResultsRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

Properties

configuration: Configuration = ...

Methods

  • Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. Attach a WebHook URL to an inbox

    Parameters

    Returns Promise<WebhookDto>

  • Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. Attach a WebHook URL to an inbox

    Parameters

    Returns Promise<ApiResponse<WebhookDto>>

  • Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload. Redrive all webhook results that have failed status

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<WebhookRedriveAllResult>