@apideck/node/dist/gen/models/WebhookEventLog.d.ts

Apideck Node.js SDK

/**
 * Apideck
 * The Apideck OpenAPI Spec: SDK Optimized
 *
 * The version of the OpenAPI document: 10.13.0
 * Contact: support@apideck.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { UnifiedApiId } from './UnifiedApiId';
import { WebhookEventLogAttempts } from './WebhookEventLogAttempts';
import { WebhookEventLogService } from './WebhookEventLogService';
/**
 *
 * @export
 * @interface WebhookEventLog
 */
export interface WebhookEventLog {
    /**
     *
     * @type {string}
     * @memberof WebhookEventLog
     */
    id?: string;
    /**
     * HTTP Status code that was returned.
     * @type {number}
     * @memberof WebhookEventLog
     */
    status_code?: number;
    /**
     * Whether or not the request was successful.
     * @type {boolean}
     * @memberof WebhookEventLog
     */
    success?: boolean;
    /**
     * ID of your Apideck Application
     * @type {string}
     * @memberof WebhookEventLog
     */
    application_id?: string;
    /**
     * Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.
     * @type {string}
     * @memberof WebhookEventLog
     */
    consumer_id?: string;
    /**
     *
     * @type {UnifiedApiId}
     * @memberof WebhookEventLog
     */
    unified_api?: UnifiedApiId;
    /**
     *
     * @type {WebhookEventLogService}
     * @memberof WebhookEventLog
     */
    service?: WebhookEventLogService;
    /**
     * The URL of the webhook endpoint.
     * @type {string}
     * @memberof WebhookEventLog
     */
    endpoint?: string;
    /**
     * Name of source event that webhook is subscribed to.
     * @type {string}
     * @memberof WebhookEventLog
     */
    event_type?: string;
    /**
     * Number of attempts webhook endpoint was called before a success was returned or eventually failed
     * @type {number}
     * @memberof WebhookEventLog
     */
    execution_attempt?: number;
    /**
     * HTTP Method of request to endpoint.
     * @type {string}
     * @memberof WebhookEventLog
     */
    http_method?: string;
    /**
     * ISO Date and time when the request was made.
     * @type {string}
     * @memberof WebhookEventLog
     */
    timestamp?: string;
    /**
     * Name of the Entity described by the attributes delivered within payload
     * @type {string}
     * @memberof WebhookEventLog
     */
    entity_type?: string;
    /**
     * The JSON stringified payload that was delivered to the webhook endpoint.
     * @type {string}
     * @memberof WebhookEventLog
     */
    request_body?: string;
    /**
     * The JSON stringified response that was returned from the webhook endpoint.
     * @type {string}
     * @memberof WebhookEventLog
     */
    response_body?: string;
    /**
     * If the request has not hit the max retry limit and will be retried.
     * @type {boolean}
     * @memberof WebhookEventLog
     */
    retry_scheduled?: boolean;
    /**
     * record of each attempt to call webhook endpoint
     * @type {Array<WebhookEventLogAttempts>}
     * @memberof WebhookEventLog
     */
    attempts?: Array<WebhookEventLogAttempts>;
}
export declare function WebhookEventLogFromJSON(json: any): WebhookEventLog;
export declare function WebhookEventLogFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookEventLog;
export declare function WebhookEventLogToJSON(value?: WebhookEventLog | null): any;